mirror of https://git.selfprivacy.org/SelfPrivacy/selfprivacy-rest-api.git synced 2024-10-31 17:17:17 +00:00

Go to file

Houkime e13ad71a93 feature(backups): remove all json logic		2024-01-24 14:36:44 +00:00
.idea	chore: Project files for IDEA	2023-02-06 11:50:16 +03:00
.vscode	Migrate to FastAPI (#13 )	2022-08-25 20:03:56 +03:00
nixos	refactor: Move from nix-shell to nix flake	2024-01-10 15:05:10 +02:00
selfprivacy_api	feature(backups): remove all json logic	2024-01-24 14:36:44 +00:00
tests	feature(backups): remove all json logic	2024-01-24 14:36:44 +00:00
.coveragerc	More unit tests and bugfixes (#7 )	2022-01-10 22:35:00 +02:00
.drone.yml	ci: Give redis some time to start?	2023-07-17 19:55:16 +03:00
.flake8	style: set 88 as a line length limit	2023-07-19 16:49:35 +03:00
.gitignore	refactor: Move from nix-shell to nix flake	2024-01-10 15:05:10 +02:00
.pylintrc	style: set 88 as a line length limit	2023-07-19 16:49:35 +03:00
CONTRIBUTING.md	docs: add CONTRIBUTING.md	2022-12-30 21:21:34 +03:00
default.nix	refactor: Move from nix-shell to nix flake	2024-01-10 15:05:10 +02:00
flake.lock	refactor: Move from nix-shell to nix flake	2024-01-10 15:05:10 +02:00
flake.nix	refactor: Move from nix-shell to nix flake	2024-01-10 15:05:10 +02:00
LICENSE	Add a license	2021-11-18 10:05:04 +02:00
nix-dependencies-diagram.puml	refactor: Move from nix-shell to nix flake	2024-01-10 15:05:10 +02:00
pyproject.toml	Migrate to FastAPI (#13 )	2022-08-25 20:03:56 +03:00
README.md	docs: Add a note about how to use experimental nix features	2024-01-10 17:17:36 +03:00
setup.py	chore(version): bump version to 3.0, no Rest API	2024-01-08 13:14:50 +00:00

README.md

SelfPrivacy GraphQL API which allows app to control your server

build

$ nix build

As a result, you should get the ./result symlink to a folder (in /nix/store) with build contents.

develop & test

$ nix develop
$ [SP devshell] pytest .
=================================== test session starts =====================================
platform linux -- Python 3.10.11, pytest-7.1.3, pluggy-1.0.0
rootdir: /data/selfprivacy/selfprivacy-rest-api
plugins: anyio-3.5.0, datadir-1.4.1, mock-3.8.2
collected 692 items

tests/test_block_device_utils.py .................                                    [  2%]
tests/test_common.py .....                                                            [  3%]
tests/test_jobs.py ........                                                           [  4%]
tests/test_model_storage.py ..                                                        [  4%]
tests/test_models.py ..                                                               [  4%]
tests/test_network_utils.py ......                                                    [  5%]
tests/test_services.py ......                                                         [  6%]
tests/test_graphql/test_api.py .                                                      [  6%]
tests/test_graphql/test_api_backup.py ...............                                 [  8%]
tests/test_graphql/test_api_devices.py .................                              [ 11%]
tests/test_graphql/test_api_recovery.py .........                                     [ 12%]
tests/test_graphql/test_api_version.py ..                                             [ 13%]
tests/test_graphql/test_backup.py ...............................                     [ 21%]
tests/test_graphql/test_localsecret.py ...                                            [ 22%]
tests/test_graphql/test_ssh.py ............                                           [ 23%]
tests/test_graphql/test_system.py .............................                       [ 28%]
tests/test_graphql/test_system_nixos_tasks.py ........                                [ 29%]
tests/test_graphql/test_users.py ..................................                   [ 42%]
tests/test_graphql/test_repository/test_json_tokens_repository.py                     [ 44%]
tests/test_graphql/test_repository/test_tokens_repository.py ....                     [ 53%]
tests/test_rest_endpoints/test_auth.py ..........................                     [ 58%]
tests/test_rest_endpoints/test_system.py ........................                     [ 63%]
tests/test_rest_endpoints/test_users.py ................................              [ 76%]
tests/test_rest_endpoints/services/test_bitwarden.py ............                     [ 78%]
tests/test_rest_endpoints/services/test_gitea.py ..............                       [ 80%]
tests/test_rest_endpoints/services/test_mailserver.py .....                           [ 81%]
tests/test_rest_endpoints/services/test_nextcloud.py ............                     [ 83%]
tests/test_rest_endpoints/services/test_ocserv.py ..............                      [ 85%]
tests/test_rest_endpoints/services/test_pleroma.py ..............                     [ 87%]
tests/test_rest_endpoints/services/test_services.py ....                              [ 88%]
tests/test_rest_endpoints/services/test_ssh.py .....................                  [100%]

============================== 692 passed in 352.76s (0:05:52) ===============================

If you don't have experimental flakes enabled, you can use the following command:

nix --extra-experimental-features nix-command --extra-experimental-features flakes develop

dependencies and dependant modules

Current flake inherits nixpkgs from NixOS configuration flake. So there is no need to refer to extra nixpkgs dependency if you want to be aligned with exact NixOS configuration.

Nix code for NixOS service module for API is located in NixOS configuration repository.

current issues

It's not clear how to store in this repository information about several compatible NixOS configuration commits, where API application tests pass. Currently, here is only a single flake.lock.