Flask API for file-sharing.
Go to file
2023-05-18 22:06:16 -04:00
contrib contrib/testcmds.fish: updated 2023-05-07 22:14:15 -04:00
docs docs/authentication.rst: added content 2023-05-18 20:29:56 -04:00
migrations models.py: logic error 2023-05-08 18:54:40 -04:00
sachet /users: added endpoint for creating, listing users 2023-05-18 22:06:16 -04:00
tests /users: added endpoint for creating, listing users 2023-05-18 22:06:16 -04:00
.gitignore added boilerplate for sphinx 2023-05-17 20:56:29 -04:00
config-testing.yml Fix configurations 2023-03-10 18:17:03 -05:00
config.yml.example storage: implemented filesystem 2023-04-08 18:35:56 -04:00
pytest.ini Fix configurations 2023-03-10 18:17:03 -05:00
README.md README.md: added extra info 2023-04-30 20:54:26 -04:00
requirements.txt added boilerplate for sphinx 2023-05-17 20:56:29 -04:00

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