unna97 / audio-annonation Goto Github PK

Is your feature request related to a problem? Please describe.
DevOps infrastructure for automated development environment setup as well as source code linting, formatting, and testing optimizes development workflows.

Describe the solution you'd like

We'll need:

1. setup.sh: for automated development environment set up (targets are poetry 1.5.1, Python3.11, PostgresSQL 16, and Docker 24.0.6)
2. Makefile: with commands for installing Python dependencies, linting, formatting, and testing

Describe alternatives you've considered
Ubuntu is the development and deployment target.

Additional context
Software versions may change as development progresses, but the base infrastructure is important.

Is your feature request related to a problem? Please describe.
Need an improved technical documentation. Technical documentation to facilitate not just product usage but also related to contributions.

Describe the solution you'd like

1. README.md : Describe easy installation and setup.
2. Product Documentation: How to use the annotator + the different features available
3. Contributing guidelines and a code of conduct;
4. Code documentation: documentation inside each function (for function definition) & file , API documentation using swagger
5. Project documentation: Documentation on approach chosen & it's reasoning should be included.

Additional context
https://jamesg.blog/category/advent-of-technical-writing/

Is your feature request related to a problem? Please describe.
Poetry allows us to have finer grain control over our dependency management, integrates package management and configuration into a pyproject.toml file, and yields a poetry.lock file for parity between development, testing, and deployment environments.

Describe the solution you'd like
We'll need a to install Poetry as part of our automated environment set up and configure our project dependencies using a pyproject.toml file - dependencies will be migrated from the requirements.txt and conda environment.yml file.

Describe alternatives you've considered
We could also opt for a pure pip approach - this does require configuration management for dependencies and packaging to be handled by using multiple files.

Poetry can emit a requirements.txt file for specific deployment requirements as needed.

Additional context
As per meeting, we'll move forward with Poetry.

Removing media backend solved the issue with playback. You don't need the pre-generated peaks.

• currently all functionality are being called from views which we need to refactor by separating utilities (or helper functions) and DAOs (Data access objects) from views.

• #13
• #14
• #15

Use WhiteNoise to serve static and media file

Is your feature request related to a problem? Please describe.
A continuous integration pipeline ensures that we're merging validated code into our code base.

Describe the solution you'd like
We'll use a GitHub Action that triggers on pull requests to main and installs, lints, and tests application and new features.

Describe alternatives you've considered
GitHub Actions fits our needs well.

Instead of leaving print function in repo we can use logging and let use only in debug mode not in production
example.

logging.debug("This is a debug message")
logging.warning("This is a warning message")