Data

Tools

Indexes

Applications

Experiments

Open Source Science

python_template

A template repository for linting, testing, GUI building and dockerizing python scripts.

https://github.com/michabirklbauer/python_template

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.2%) to scientific vocabulary

Keywords

docker python template
Last synced: 6 months ago · JSON representation ·

Repository

A template repository for linting, testing, GUI building and dockerizing python scripts.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Topics
docker python template
Created almost 2 years ago · Last pushed over 1 year ago
Metadata Files
Readme License Citation

README.md

workflow_state

Template Repository for Python Scripts

A template repository for linting, testing, GUI building and dockerizing python scripts.

Checklist

  • Replace YOURUSERNAME and IMAGENAME in .github/workflows/docker-image.yml [or delete file].
  • Replace example [line 5] with an appropriate name in .github/workflows/python-app.yml.
  • Setup the appropriate copy statements [line >29] in .github/workflows/python-app.yml.
  • Replace test data in data with your own data [or delete if you don't have test data].
  • Adjust .gitattributes according to your needs.
  • Adjust .gitignore according to your needs.
  • Setup your CITATION.cff according to your needs [or delete file].
  • Replace dummy values in Dockerfile and write image instructions.
  • Replace copyright name in LICENSE.
  • Replace lines 3 - 6 and write your script in main.py.
  • Replace lines 3 - 6 and write your gui in gui/streamlit_app.py.
  • Replace lines 3 - 6 and write tests in tests/tests.py.
  • Add your requirements to requirements.txt.
  • Document your script with Sphinx:
    • Install Sphinx and the PyData theme: pip install sphinx pydata-sphinx-theme.
    • Adjust the configuration to your needs in docs_src/conf.py.
    • Write documentation!
    • Build documentation with: sphinx-apidoc -f -o docs_src . sphinx-build -b html docs_src docs
    • Publish documentation [optional]!
    • Serving with GitHub pages needs the addition of an empty .nojekyll file to your /docs.
  • Adjust this README.md to your needs!

Known Issues

List of known issues

Citing

If you are using PLACEHOLDER script please cite: Very important title Important Author, and Another Important Author Journal of Cool Stuff 2023 12 (3), 4567-4589 DOI: 12.3456/cool-stuff

License

Contact

Owner

  • Name: Micha Birklbauer
  • Login: michabirklbauer
  • Kind: user
  • Location: Linz, Austria

Data Scientist & Bioinformatician @ FHOOE Hagenberg

Citation (CITATION.cff) 

cff-version: 1.2.0
preferred-citation:
  type: article
  authors:
  - family-names: "Last Name"
    given-names: "First Name"
    orcid: "https://orcid.org/1234-5678-1234-5678"
  doi: "12.3456/cool-stuff"
  journal: "Journal of Cool Stuff"
  month: 1
  start: 4567
  end: 4589
  title: "Very important title"
  issue: 3
  volume: 12
  year: 2024

GitHub Events

Total
  • Push event: 4
  • Pull request event: 2
Last Year
  • Push event: 4
  • Pull request event: 2

Issues and Pull Requests

Last synced: 12 months ago

All Time
  • Total issues: 0
  • Total pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 minutes
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 6
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 6
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • michabirklbauer (11)
Top Labels
Issue Labels
Pull Request Labels
documentation (7) enhancement (7)

Dependencies

.github/workflows/docker-image.yml actions
  • actions/checkout v3 composite
.github/workflows/python-app.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
Dockerfile docker
  • python 3.12.0 build
requirements.txt pypi
  • pandas *