https://github.com/esipfed/usage-based-discovery
usage-based data discovery tool
https://github.com/esipfed/usage-based-discovery
Last synced: 10 months ago
JSON representation
usage-based data discovery tool
- Host: GitHub
- URL: https://github.com/esipfed/usage-based-discovery
- Owner: ESIPFed
- Created: 2020-08-01T02:56:57.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2022-11-01T18:12:31.000Z (over 3 years ago)
- Last Synced: 2025-03-06T02:36:30.776Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 235 MB
- Stars: 3
- Watchers: 3
- Forks: 7
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## Development
The following instructions have only been tested on macOS. However the app can be run entirely in Docker (see [Makefile](Makefile) for relevant Docker commands).
- Install (and use) **python3.8**. We recommend using a tool like **pyenv**.
- Install Docker Desktop
- Clone this repo and navigate to the root directory.
- Create .env.development in the root directory and set `ORCID=` a value in [orcid.json](./orcid.json) to simulate role=supervisor (or blank for role=general) when logged in
- `$ python3.8 -m venv ./venv`
- `$ source venv/bin/activate`
- `$ pip3 install -r requirements-dev.txt`
- `$ make app` and navigate to localhost:5000
Test via `$ make test`.
## Security
Install git-secrets on your machine to prevent yourself from accidentally committing sensitive info (like access keys, secrets) to your GitHub repo:
https://github.com/awslabs/git-secrets
Use Python Safety (https://github.com/pyupio/safety) to check your installed dependencies for known security vulnerabilities:
`$ safety check -r requirements.txt`
Use Python Bandit (https://github.com/PyCQA/bandit) to find common security issues in your Python code:
`$ bandit -r ~/your_repos/project`
**Snyk** is used as a blocking step to check dependencies for vulnerabilities when deploying to any environment.
## Contributing
Any questions or suggestions for improvement?
- Create an issue, and use the templates for feature request or bug reports for improvements
- Questions - email vincent.inverso@nasa.gov
If looking to contribute, please look at [CONTRIBUTING.md](CONTRIBUTING.md).