Skip to content
This repository has been archived by the owner on Jan 20, 2024. It is now read-only.

Commit

Permalink
Migrate to pipenv for dependency management
Browse files Browse the repository at this point in the history
  • Loading branch information
tdemin committed Dec 23, 2019
1 parent 3f90b1e commit 8c8402d
Show file tree
Hide file tree
Showing 4 changed files with 325 additions and 4 deletions.
17 changes: 17 additions & 0 deletions Pipfile
@@ -0,0 +1,17 @@
[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true

[dev-packages]
pylint = "*"
yapf = "*"

[packages]
bcrypt = "==3.1.6"
flask-sqlalchemy = "==2.4.0"
flask-cors = "==3.0.8"
flask = "==1.0.3"

[requires]
python_version = "3.7"
299 changes: 299 additions & 0 deletions Pipfile.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 9 additions & 4 deletions README.md
Expand Up @@ -17,19 +17,21 @@ Example config:
// see https://docs.sqlalchemy.org/en/13/core/engines.html#database-urls
"allow_signup": false, // whether to allow /api/signup or not
"loglevel": 0, // 0: errors, 1: warnings, 2: info
"domain": "https://your.domain.tld" // full domain with HTTPS
// needed for CORS
"domain": "https://your.domain.tld" // full domain with HTTPS, needed for CORS
}

If there are environment variables `AMBER_DATABASE` / `AMBER_ALLOW_SIGNUP` /
`AMBER_LOGLEVEL`, `AMBER_DOMAIN` set, the program will respect them and use
`AMBER_LOGLEVEL` / `AMBER_DOMAIN` set, the program will respect them and use
over the values provided with the config file.

#### Dependencies

This app directly depends on `flask`, `flask-sqlalchemy`, `flask-cors`, and
`bcrypt`.

`requirements.txt` is left only so that pipenv is not needed while building the
app in Docker. Please use pipenv in development.

#### Running in Docker

The Dockerfile included with the project assumes that:
Expand All @@ -40,7 +42,10 @@ the app without a reverse proxy won't work because of the current uwsgi
configuration).

If you have to/prefer to use MariaDB, etc, you'll have to add the necessary
Python packages to the Docker image by hand.
Python packages to the Docker image by hand. See [SQLAlchemy docs][SAd] for
details.

[SAd]: https://docs.sqlalchemy.org/en/13/core/engines.html#database-urls

#### Licenses

Expand Down
Binary file modified requirements.txt
Binary file not shown.

0 comments on commit 8c8402d

Please sign in to comment.