Flask API for file-sharing.
dogeystamp
65cae632b7
- added readthedocs.yaml - write down steps to compile docs locally - separated requirements for Sphinx and for Sachet |
||
|---|---|---|
| contrib | ||
| docs | ||
| migrations | ||
| sachet | ||
| tests | ||
| .gitignore | ||
| .readthedocs.yaml | ||
| config-testing.yml | ||
| config.yml.example | ||
| LICENSE | ||
| pytest.ini | ||
| README.md | ||
| requirements.txt | ||
sachet
sachet is a small file share server.
development
To start sachet in development mode:
Clone the repo.
git clone https://github.com/dogeystamp/sachet
cd sachet
Create a venv with required dependencies:
python -m venv venv
source venv/bin/activate
python -m pip3 install -r requirements.txt
Create a configuration file (and set the secret key!)
cp config.yml.example config.yml
vim config.yml
Start Flask in development mode:
flask --debug --app sachet.server run
tests
Tests are available with the following command:
pytest --cov --cov-report term-missing
linting
Please use the linter before submitting code.
black .
database maintenance
To clean up the database (remove stale entries):
flask --app sachet.server cleanup
Otherwise, to upgrade the database after a schema change:
flask --app sachet.server db upgrade