Data

Tools

Indexes

Applications

Experiments

Open Source Science

python_project_template

Template repository for a Python Project

https://github.com/claasrostock/python_project_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 (9.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Template repository for a Python Project

Basic Info
  • Host: GitHub
  • Owner: ClaasRostock
  • License: mit
  • Language: Python
  • Default Branch: main
  • Size: 368 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 9
Created about 3 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Citation

README.md

Python Project Template

Template repository for Python projects.

Create a new repository based on this template

  • On GitHub, create a new repository. When prompted, select pythonprojecttemplate as template.
  • Clone the new repository to your local machine.

Rename package name, author, etc in the newly created repository

  1. In your local clone (i.e. on your local machine), enter any new names in the names.csv file to change the package name, author name etc.
    Enter new values right after the , in each line. Leave empty for fields you do not want to be set.
    Mandatory fields are:
    PackageNameDashed , e.g. my-package
    PackageNameCapitalized , e.g. MyPackage
    GitHubOrganisation , e.g. owner
    Author1Name , e.g. Author One
    Author1Email , e.g. author.one@xyz.com
    All other fields are optional (yet will help you to set up the package more comprehensively).
  2. In your local terminal, run ./rename_package.ps1. This will create a new local branch named rename-package in which all name changes get applied.
  3. Review the changes made in the rename-package branch.
  4. If ok, merge rename-package into main.
    If not ok, delete the local branch rename-package, and repeat from step 1.
  5. Finally, push your changes in main to remote.

Create "RELEASE_TOKEN"

  • In the GitHub Settings of the newly created repository, create an environment named release, and within that a secret named RELEASE_TOKEN containing a personal access token (PAT) from you. The PAT need to have the following scope:
    • gist
    • repo
    • workflow

Owner

  • Name: Claas Rostock
  • Login: ClaasRostock
  • Kind: user

Citation (CITATION.cff) 

title: my-package
version: 0.1.0
abstract: >-
  my-package is an example package supporting xyz.
type: software
authors:
  - name: Owner
    address: 'Street 1'
    post-code: '1234'
    city: City
    country: DE
    website: 'https://www.xyz.com/'
  - given-names: Author
    family-names: One
    affiliation: Owner
    email: author.one@xyz.com
    website: 'https://www.linkedin.com/in/authorone'
  - given-names: Author
    family-names: Two
    affiliation: Owner
    email: author.two@xyz.com
    website: 'https://www.linkedin.com/in/authortwo'
  - given-names: Author
    family-names: Three
    affiliation: Owner
    email: author.three@xyz.com
    website: 'https://www.linkedin.com/in/authorthree'
keywords:
  - Keyword One
  - Keyword Two
  - Keyword Three
license: MIT
license-url: 'https://owner.github.io/my-package/LICENSE.html'
url: 'https://owner.github.io/my-package/README.html'
repository-code: 'https://github.com/owner/my-package'
message: 'Please cite this software using these metadata.'
cff-version: 1.2.0

GitHub Events

Total
  • Release event: 2
  • Delete event: 5
  • Issue comment event: 4
  • Push event: 255
  • Pull request review comment event: 8
  • Pull request review event: 5
  • Pull request event: 9
  • Create event: 7
Last Year
  • Release event: 2
  • Delete event: 5
  • Issue comment event: 4
  • Push event: 255
  • Pull request review comment event: 8
  • Pull request review event: 5
  • Pull request event: 9
  • Create event: 7

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 1
  • Total pull requests: 22
  • Average time to close issues: about 1 hour
  • Average time to close pull requests: about 1 hour
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.55
  • Merged pull requests: 18
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 16
  • Average time to close issues: N/A
  • Average time to close pull requests: 13 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.75
  • Merged pull requests: 13
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • ClaasRostock (1)
Pull Request Authors
  • ClaasRostock (33)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

.github/workflows/_build_and_publish_documentation.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • ammaraskar/sphinx-problem-matcher master composite
  • peaceiris/actions-gh-pages v3 composite
.github/workflows/_build_package.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
.github/workflows/_code_quality.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • psf/black stable composite
.github/workflows/_merge_into_release.yml actions
  • actions/checkout v3 composite
  • devmasx/merge-branch v1.4.0 composite
.github/workflows/_publish_package.yml.disabled actions
  • actions/download-artifact v3 composite
  • pypa/gh-action-pypi-publish v1.5.2 composite
.github/workflows/_test.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/_test_future.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
.github/workflows/nightly_build.yml actions
.github/workflows/publish_release.yml actions
.github/workflows/pull_request_to_main.yml actions
.github/workflows/push.yml actions
.github/workflows/push_to_main.yml actions
.github/workflows/push_to_release.yml actions
pyproject.toml pypi
requirements-dev.txt pypi
  • Sphinx >=7.2 development
  • black >=23.7 development
  • furo >=2023.8.19 development
  • myst-parser >=2.0 development
  • pyright ==1.1.321 development
  • pytest >=7.4 development
  • pytest-cov >=4.1 development
  • pytest-randomly >=3.15 development
  • ruff >=0.0.285 development
  • sourcery >=1.8.0 development
  • sphinx-argparse-cli >=1.11 development
requirements.txt pypi
  • dictIO >=0.2.7