Data

Tools

Indexes

Applications

Experiments

Open Source Science

template_python

A template repository that Python projects can inherit from to ensure tooling consistency

https://github.com/nicholassynovic/template_python

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 (5.7%) to scientific vocabulary

Keywords

template
Last synced: 6 months ago · JSON representation ·

Repository

A template repository that Python projects can inherit from to ensure tooling consistency

Basic Info
  • Host: GitHub
  • Owner: NicholasSynovic
  • License: agpl-3.0
  • Language: Makefile
  • Default Branch: main
  • Homepage:
  • Size: 57.6 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 1
  • Open Issues: 2
  • Releases: 0
Topics
template
Created over 1 year ago · Last pushed 8 months ago
Metadata Files
Readme Contributing Funding License Code of conduct Citation Codeowners Security Support Governance

README.md

Python Template Repository

A template repository that Python projects can inherit from to ensure tooling consistency

Table of Contents

About

This is a template repository that is intended to be inherited by other template repositories to ensure consistent common tool deployment Python projects.

This will also support tooling from my template_base repository.

Additionally, while projects can leverage this template or its content, extending this template is encouraged

Supported Tooling

Visual Studio Code

Modifies and extends original template_base

Development Containers

Base Template

All template_base tooling is supported

.gitignore

requirements.txt

Poetry

Pre-Commit

Modifies and extends original template_base

Hooks

Encouraged Tooling

For API docs, please consider using one of the following:

Template Structure

Generated with File Tree Generator

shell 📦template_python ┣ 📂.devcontainer ┃ ┗ 📜devcontainer.json ┣ 📂.github ┃ ┣ 📂DISCUSSION_TEMPLATE ┃ ┃ ┣ 📜implementations.yml ┃ ┃ ┗ 📜requests.yml ┃ ┣ 📂ISSUE_TEMPLATE ┃ ┃ ┗ 📜bug-report.yml ┃ ┣ 📂workflows ┃ ┃ ┣ 📜jekyll-gh-pages.yml ┃ ┃ ┗ 📜pre-commit.yml ┃ ┣ 📜CODEOWNERS ┃ ┣ 📜CODE_OF_CONDUCT.md ┃ ┣ 📜CONTRIBUTING.md ┃ ┣ 📜FUNDING.yml ┃ ┣ 📜GOVERNANCE.md ┃ ┣ 📜SECURITY.md ┃ ┗ 📜SUPPORT.md ┣ 📂docs ┃ ┗ 📜.gitkeep ┣ 📂src ┃ ┣ 📜__init__.py ┃ ┗ 📜main.py ┣ 📜.gitignore ┣ 📜.isort.cfg ┣ 📜.markdownlint.json ┣ 📜.mdformat.toml ┣ 📜.pre-commit-config.yaml ┣ 📜.rad.json ┣ 📜CITATION.cff ┣ 📜Dockerfile ┣ 📜LICENSE ┣ 📜Makefile ┣ 📜README.md ┣ 📜README.md.bk ┣ 📜poetry.lock ┣ 📜pyproject.toml ┗ 📜requirements.txt

Owner

  • Name: Nicholas Synovic
  • Login: NicholasSynovic
  • Kind: user
  • Location: Chicago, IL

Loyola University Chicago Computer Science Student Expected Graduation: May 2022

Citation (CITATION.cff) 

# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

GitHub Events

Total
  • Push event: 18
Last Year
  • Push event: 18

Issues and Pull Requests

Last synced: 11 months ago

All Time
  • Total issues: 2
  • Total pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 2
  • Total pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 2
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 2
  • Pull request authors: 0
  • Average comments per issue: 0.0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • NicholasSynovic (1)
  • gkthiruvathukal (1)
Pull Request Authors
Top Labels
Issue Labels
bug (1)
Pull Request Labels

Dependencies

Dockerfile docker
  • python 3.10-bookworm build
poetry.lock pypi
pyproject.toml pypi
  • python ^3.10
requirements.txt pypi
  • poetry *
  • sphinx *
.github/workflows/build.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite
  • softprops/action-gh-release v2 composite
.github/workflows/jekyll-gh-pages.yml actions
  • actions/checkout v4 composite
  • actions/configure-pages v5 composite
  • actions/deploy-pages v4 composite
  • actions/jekyll-build-pages v1 composite
  • actions/upload-pages-artifact v3 composite
.github/workflows/pre-commit.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v5 composite