Maven
Maven: "one who is experienced or knowledgeable."
This repository holds the software interacting with the maven database. Maven is currently a work in progress.
Aims
The maven database will be used to store quality metrics for cases and their analysis that come through Clinical Genomics.
Developing Maven
Steps to start developing on Maven locally:
- Clone the repo
git clone https://github.com/Clinical-Genomics/maven
- Create a working environment
- Requires poetry to be installed: https://python-poetry.org/docs/
2a. Create a virtual python environment in the directory
# Go into the directory
cd ./maven
# Create a virtual environment
python3 -m venv maven
# Activate the virtual environment
source venv/bin/activate
# Install packages
poetry install
2b. If you are using pycharm setup a poetry interpreter
-
Install a mongodb client locally (for now) follow steps outlined here
-
Start a mongo server locally that runs the database
brew services start mongodb-community@7.0
- to stop the service when wanted
brew services stop mongodb-community@7.0
-
To establish a connection to the database with FastApi and uvicorn run:
python3 -m uvicorn --reload --app-dir ./api main:app
- If this step worked you should see "Connected to database." in the terminal
-
To view the database in Compass
- https://www.mongodb.com/products/tools/compass
- Setup a connection to the localhost
- Create a new database called "maven"
-
Alternatively to the steps above one can also run maven using docker 7a. Install docker and start the docker application: https://docs.docker.com/engine/install/
- After step 1
cd ./maven docker compose up
Metadata
Release files for cg-maven 0.1.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| cg_maven-0.1.6.tar.gz | 7.0 kB | Without provenance | Details for cg_maven-0.1.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| cg_maven-0.1.6-py3-none-any.whl | Python 3 | none | any | Details for cg_maven-0.1.6-py3-none-any.whl |
Total release size: 16.9 kB
Release files / cg_maven-0.1.6.tar.gz
| Download URL | cg_maven-0.1.6.tar.gz |
|---|---|
| Size | 7.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d81c51ce452cf3c0a5c5fa173306824a3a2e22ec35915cfd1758c9a2e4288c93
|
|
BLAKE2b-256 checksum How to use checksums |
a32d695b138da2d1293ef40e04d2c615377ab23345594c9a6c5414bbbbeb24b3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.11.6 Linux/6.2.0-1016-azure
|
Release files / cg_maven-0.1.6-py3-none-any.whl
| Download URL | cg_maven-0.1.6-py3-none-any.whl |
|---|---|
| Size | 10.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2da29604b6fb7c42de3c9970ab86dd97435194a216952098165673f31b169bc8
|
|
BLAKE2b-256 checksum How to use checksums |
af253475ded550fdc3ef06af247596a4e19476c7ea95e714a7acd4177b593119
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.11.6 Linux/6.2.0-1016-azure
|
Security for cg-maven 0.1.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.