Science Score: 59.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 1 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
✓Committers with academic emails
5 of 14 committers (35.7%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (15.0%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
PDS web APIs specifications and user's manual
Basic Info
- Host: GitHub
- Owner: NASA-PDS
- License: other
- Language: Python
- Default Branch: main
- Homepage: http://nasa-pds.github.io/pds-api
- Size: 21.2 MB
Statistics
- Stars: 6
- Watchers: 7
- Forks: 3
- Open Issues: 34
- Releases: 13
Topics
Metadata Files
README.md
NASA PDS Federated API
PDS strives to develop REST-ful web APIs for all online web applications, including data search and DOI management.
This repository is the entry point for the NASA PDS Federated API specifications (e.g. following OpenAPI standard) and their documentation.
Please visit our website at https://nasa-pds.github.io/pds-api/ for user documentation.
Prerequisites
- Python 3
For PDF generation, basiclatex and accompanying libraries are needed
brew install basictex sudo /Library/TeX/texbin/tlmgr update --self sudo /Library/TeX/texbin/tlmgr install latexmk sudo /Library/TeX/texbin/tlmgr install tex-gyre sudo /Library/TeX/texbin/tlmgr install fncychap sudo /Library/TeX/texbin/tlmgr install wrapfig sudo /Library/TeX/texbin/tlmgr install capt-of sudo /Library/TeX/texbin/tlmgr install framed sudo /Library/TeX/texbin/tlmgr install needspace sudo /Library/TeX/texbin/tlmgr install tabulary sudo /Library/TeX/texbin/tlmgr install varwidth sudo /Library/TeX/texbin/tlmgr install titlesec
Generate the user's documentation
Set the overall version (e.g. build number) in docs/source/conf.py
The OpenAPI yaml unresolved specifications are stored in the specs directory.
The naming of the specification are: PDS_APIs-{application}-{version}-swagger.yaml
For example: PDS_APIs-registry-1.0.0-swagger.yaml
To add a new specification or a new version of a specification:
- Copy the OpenAPI Specification under the
specsdirectory following the above filename convention. - Add a new entry for this file in
docs/source/specifications.rst - In the file
docs/source/conf.pyadd a section for the new specification in theredocobject. Generate a PDF of the documentation.
cd docs/ make latexpdf cp build/latex/pdsapis.pdf build/html/_staticGenerate the Sphinx documentation:
``` pip install -e '.[dev]'
sphinx-build -b html docs/source docs/build/html ```
Code of Conduct
All users and developers of the NASA-PDS software are expected to abide by our Code of Conduct. Please read this to ensure you understand the expectations of our community.
Development
To develop this project, use your favorite text editor, or an integrated development environment with Python support, such as PyCharm.
Contributing
For information on how to contribute to NASA-PDS codebases please take a look at our Contributing guidelines.
CI/CD
The template repository comes with our two "standard" CI/CD workflows, stable-cicd and unstable-cicd. The unstable build runs on any push to main ( ignoring changes to specific files) and the stable build runs on push of a release branch of the form release/<release version>. Both of these make use of our GitHub actions build step, Roundup. The unstable-cicd will generate (and constantly update) a SNAPSHOT release. If you haven't done a formal software release you will end up with a v0.0.0-SNAPSHOT release (see NASA-PDS/roundup-action#56 for specifics).
Owner
- Name: NASA Planetary Data System Software
- Login: NASA-PDS
- Kind: organization
- Email: pds-operator@jpl.nasa.gov
- Website: https://nasa-pds.github.io/
- Repositories: 106
- Profile: https://github.com/NASA-PDS
GitHub Events
Total
- Create event: 9
- Issues event: 7
- Release event: 7
- Watch event: 1
- Delete event: 17
- Issue comment event: 10
- Push event: 22
- Pull request review event: 3
- Pull request event: 5
Last Year
- Create event: 9
- Issues event: 7
- Release event: 7
- Watch event: 1
- Delete event: 17
- Issue comment event: 10
- Push event: 22
- Pull request review event: 3
- Pull request event: 5
Committers
Last synced: almost 3 years ago
All Time
- Total Commits: 294
- Total Committers: 14
- Avg Commits per committer: 21.0
- Development Distribution Score (DDS): 0.694
Top Committers
| Name | Commits | |
|---|---|---|
| PDSEN CI Bot | p****i@j****v | 90 |
| tloubrieu | l****u@j****v | 58 |
| Jordan Padams | 3****s@u****m | 41 |
| Jordan Padams | j****s@j****v | 26 |
| thomas loubrieu | t****u@j****v | 22 |
| SwaggerHub | S****b@s****m | 19 |
| thomas loubrieu | 6****l@u****m | 17 |
| Ramesh Maddegoda | 9****a@u****m | 8 |
| Sean Kelly | k****y@s****z | 6 |
| Jimmie Young | j****g@g****m | 3 |
| al-niessner | 1****r@u****m | 1 |
| Eugene | t****t@t****m | 1 |
| Lyle Barner | l****r@j****v | 1 |
| tloubrieu | t****u@s****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 133
- Total pull requests: 14
- Average time to close issues: 5 months
- Average time to close pull requests: 7 days
- Total issue authors: 9
- Total pull request authors: 4
- Average comments per issue: 3.44
- Average comments per pull request: 0.29
- Merged pull requests: 14
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 3
- Average time to close issues: about 2 months
- Average time to close pull requests: 16 days
- Issue authors: 2
- Pull request authors: 2
- Average comments per issue: 0.5
- Average comments per pull request: 1.0
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jordanpadams (70)
- tloubrieu-jpl (44)
- msbentley (6)
- plawton-umd (5)
- gxtchen (2)
- nutjob4life (2)
- scholes-ds (1)
- jimmie (1)
- viviant100 (1)
Pull Request Authors
- tloubrieu-jpl (12)
- jordanpadams (5)
- nutjob4life (4)
- jimmie (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 25 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 5
- Total maintainers: 6
pypi.org: pds-api
A short description, about 100-120 characters, suitable for search summaries
- Homepage: https://github.com/NASA-PDS/pds-api
- Documentation: https://pds-api.readthedocs.io/
- License: apache-2.0
-
Latest release: 15.1.0
published 8 months ago
Rankings
Maintainers (6)
Dependencies
- actions/checkout v3 composite
- ad-m/github-push-action master composite
- actions/checkout v3 composite
- actions/upload-artifact v3 composite
- github/codeql-action/analyze v2 composite
- github/codeql-action/autobuild v2 composite
- github/codeql-action/init v2 composite
- NASA-PDS/roundup-action stable composite
- actions/cache v3 composite
- actions/checkout v3 composite
- NASA-PDS/roundup-action stable composite
- actions/cache v3 composite
- actions/checkout v3 composite
- black *
- coverage *
- flake8 *
- flake8-bugbear *
- flake8-docstrings *
- mypy *
- pep8-naming *
- pre-commit *
- pydocstyle *
- pytest *
- pytest-cov *
- pytest-watch *
- pytest-xdist *
- sphinx *
- sphinx-rtd-theme *
- tox *
- types-setuptools *
- actions/checkout v4 composite