short description of my pds module, less than 100-120 characters
Project description
NASA PDS DOI Service
This tools provides services for PDS operators to mint DOIs.
Prerequisites
- python 3
- a login to OSTI server
User Documentation
https://nasa-pds.github.io/pds-doi-service/
Developers
Get the code and work on a branch
git clone ...
git checkout -b "#<issue number>"
Install virtual env
pip install virtualenv
python -m venv venv
source venv/bin/activate
Deploy dependancies:
pip install -r requirements_dev.txt
or
pip intall -e .
Launch api server (to be re-worked)
pds-doi-start-dev
Test
Unit tests:
python setup.py test
Behavioral testing
You first need to get some reference datasets, in the project base directory:
curl https://pds.nasa.gov/software/test-data/pds-doi-service/aaDOI_production_submitted_labels.zip > aaDOI_production_submitted_labels.zip
unzip aaDOI_production_submitted_labels.zip
Then you can run the behavioral tests:
behave
You can also run them for a nicer reporting:
behave -f allure_behave.formatter:AllureFormatter -o ./allure ./features
allure service allure
To report to testrail
Test report can be pushed to testrail: https://cae-testrail.jpl.nasa.gov/testrail/
Project: Planetary Data System (PDS) Test suite: pds-doi-service
Set you environment:
export TESTRAIL_USER=<your email in testrail>
export TESTRAIL_KEY=<your API key in tesrail>
Run the tests:
behave
See the results in https://cae-testrail.jpl.nasa.gov/testrail/index.php?/projects/overview/168
Documentation management
Design :
See in this repository:
https://github.com/NASA-PDS/pds-doi-service/tree/master/docs
User documentation
Managed with sphynx
brew install sphinx-doc
pip install -r requirements_dev.txt
cd docs
sphinx-build -b html source build -a
Build & Release
The build and release process is managed in github actions.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pds_doi_core-1.0.0.tar.gz
.
File metadata
- Download URL: pds_doi_core-1.0.0.tar.gz
- Upload date:
- Size: 63.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 55d5e898884c8b3bdd3436da88526d02d8ecb86cb9c525dce0e2c11d97c2ced7 |
|
MD5 | dea8b398e9cc3e88a6062f58043c1ace |
|
BLAKE2b-256 | 5dcbdd930a47af35e3672378ec28bf14df8c96b349531fabf2a2d1cadb512c19 |
File details
Details for the file pds_doi_core-1.0.0-py3-none-any.whl
.
File metadata
- Download URL: pds_doi_core-1.0.0-py3-none-any.whl
- Upload date:
- Size: 94.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.50.2 CPython/3.8.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1bbe3540570d8dd54f8298ea5c2eda335eb13e31ad616a7dc2dcee4c0b27eae2 |
|
MD5 | 3d0d1be2c494588f71294ffafeb3d9c2 |
|
BLAKE2b-256 | ea7a2138c2cccd84c0af419e1e0198807106b2a009383d323f2c49c76e420d7d |