From 43a08e1ce6ad21ff08d4d2c9271a2bba080de778 Mon Sep 17 00:00:00 2001 From: Mo8it Date: Sun, 5 Jun 2022 11:13:08 +0200 Subject: [PATCH] Update READEME and pyproject --- README.adoc | 86 +++++++------------------------------------------- pyproject.toml | 4 +-- 2 files changed, 14 insertions(+), 76 deletions(-) diff --git a/README.adoc b/README.adoc index 7ac4959..bb1303b 100644 --- a/README.adoc +++ b/README.adoc @@ -4,83 +4,21 @@ image:https://img.shields.io/badge/code%20style-black-000000.svg[link=https://github.com/psf/black] image:https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336[link=https://pycqa.github.io/isort/] -== Requirements -You need to have Python version >=3.10 and Poetry installed. To install Poetry, follow the https://python-poetry.org/docs/#installation[official instructions]. +== AdvLabDB +A database with a web interface for labs. -== Starting server +Admins have an interface to manager students, groups, experiments, appointments, marks and analyse data. -IMPORTANT: Every following instruction has to be followed every time before starting the server if not mentioned otherwise. +Assistants have a separate interface to set their marks und schedule appointments with students. -=== Update code and dependencies +== Status +The software is still in beta and under active development. Don not hesitate to open issues! -Navigate to the directory `advlabdb` where the repository is _already_ cloned (otherwise clone it) and run: +== Setup +See link:docs/user_docs/server_setup.adoc[the setup documentation]. -[source,bash] ----- -git pull origin main ----- +== Known issues +* Update scripts are not working. -to pull the latest changes from the remote repository. Then run: - -[source,bash] ----- -poetry install ----- - -to install (or update) all needed packages to the virtual environment. - -=== Enter the virtual environment - -Run: - -[source,bash] ----- -poetry shell ----- - -''' - -=== Re(create) a test database - -WARNING: Running the following line *drops an eventually existing database*! The data in the database will be *lost*! This has to be done only if you are starting the server for the first time without an existing database or you want to *drop and recreate* the database. - -[source,bash] ----- -python -m advlabdb.scripts.test.test_database ----- - -This (re-)creates the database with some elements for testing. - -''' - -=== Start test server - -Now you can start the server by running: - -[source,bash] ----- -python run.py ----- - -This command will print out the URL for accessing the local server. For example: - ----- -* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit) ----- - -This URL leads to the home page where you can login with this testing admin account: - -* email: \admin@advlabdb.de -* password: admin - -NOTE: Obviously, the email address is fake. - -== ToDo - -* Deactivate assistants account after a while if not assigned to experiments -* Backups -* Logging -* Email integration + assistant reminder? -* Students code for getting information and giving feedback -* License (GNU AGPLv3?) -* Privacy policy +== What does the name mean? +**Adv**anced **Lab** **D**ata**B**ase diff --git a/pyproject.toml b/pyproject.toml index 7824b4b..7c179df 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,7 +1,7 @@ [tool.poetry] name = "advlabdb" -version = "0.4.0" -description = "Database for an (advanced) physics lab." +version = "0.5.0" +description = "Database with a web interface for labs." authors = ["Mo Bitar "] readme = "README.adoc"