Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marpogaus/minimal_python_project_skeleton

A minimal python project skeleton containing only whats essential for automated linting, testing, and releases.
https://github.com/marpogaus/minimal_python_project_skeleton

ci pip pre-commit pypi pyproject-toml pytest python python3

Last synced: about 1 month ago
JSON representation

A minimal python project skeleton containing only whats essential for automated linting, testing, and releases.

Host: GitHub
URL: https://github.com/marpogaus/minimal_python_project_skeleton
Owner: MArpogaus
License: mit
Created: 2024-02-15T13:45:04.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-09-13T16:36:24.000Z (4 months ago)
Last Synced: 2024-11-16T17:43:16.159Z (about 1 month ago)
Topics: ci, pip, pre-commit, pypi, pyproject-toml, pytest, python, python3
Language: Python
Homepage: https://marpogaus.github.io/minimal_python_project_skeleton/
Size: 31.3 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        [![img](https://img.shields.io/github/contributors/MArpogaus/python-project-skeleton.svg?style=flat-square)](https://github.com/MArpogaus/python-project-skeleton/graphs/contributors)

[![img](https://img.shields.io/github/forks/MArpogaus/python-project-skeleton.svg?style=flat-square)](https://github.com/MArpogaus/python-project-skeleton/network/members)

[![img](https://img.shields.io/github/stars/MArpogaus/python-project-skeleton.svg?style=flat-square)](https://github.com/MArpogaus/python-project-skeleton/stargazers)

[![img](https://img.shields.io/github/issues/MArpogaus/python-project-skeleton.svg?style=flat-square)](https://github.com/MArpogaus/python-project-skeleton/issues)

[![img](https://img.shields.io/github/license/MArpogaus/python-project-skeleton.svg?style=flat-square)](https://github.com/MArpogaus/python-project-skeleton/blob/main/LICENSE)

[![img](https://img.shields.io/github/actions/workflow/status/MArpogaus/python-project-skeleton/test.yaml.svg?label=test&style=flat-square)](https://github.com/MArpogaus/python-project-skeleton/actions/workflows/test.yaml)

[![img](https://img.shields.io/github/actions/workflow/status/MArpogaus/python-project-skeleton/release.yaml.svg?label=release&style=flat-square)](https://github.com/MArpogaus/python-project-skeleton/actions/workflows/release.yaml)

[![img](https://img.shields.io/badge/pre--commit-enabled-brightgreen.svg?logo=pre-commit&style=flat-square)](https://github.com/MArpogaus/python-project-skeleton/blob/main/.pre-commit-config.yaml)

[![img](https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555)](https://linkedin.com/in/MArpogaus)

[![img](https://img.shields.io/pypi/v/minimal-python-project-skeleton.svg?style=flat-square)](https://pypi.org/project/minimal-python-project-skeleton)

[![img](https://img.shields.io/pypi/pyversions/minimal-python-project-skeleton.svg?style=flat-square)](https://pypi.org/project/minimal-python-project-skeleton)

# Minimal Python Project Skeleton

1.  [About The Project](#org78704d3)

2.  [Getting Started](#org2abf3eb)

    1.  [Installation](#orge7488c3)

3.  [Contributing](#org4068d30)

4.  [License](#org227499e)

5.  [Contact](#org6fa2a28)

6.  [Acknowledgments](#org43fcc62)



## About The Project

This folder structure should act as a simple starting point for your next python project.

    .

    ├── .github

    │   └── workflows

    │       ├── docs.yaml

    │       ├── pre-commit.yaml

    │       ├── release.yaml

    │       └── test.yaml

    ├── .gitignore

    ├── .pre-commit-config.yaml

    ├── CHANGELOG.md

    ├── CONTRIBUTING.md

    ├── LICENSE

    ├── README.md

    ├── README.org

    ├── pyproject.toml

    ├── src

    │   └── minimal_python_project_skeleton

    │       └── __init__.py

    └── test

        └── test_func.py

    6 directories, 14 files

It contains just the minimum to get you started with a ready configured GitHub actions for automated [linting](), [testing](), [documenting]() and [releasing]() on PiPy.



## Getting Started

Use this template directly to [create a new GitHub repository]() or just clone the repository to your desired destination and start working on your new project.

I have marked all the relevant parts that you might want to adjust.

    .github/workflows/release.yaml:      url: https://pypi.org/p/minimal-python-project-skeleton  # TODO: Replace with your PyPI project name

    .github/workflows/release.yaml:      url: https://test.pypi.org/p/minimal-python-project-skeleton  # TODO: Replace with your TestPyPI project name

    pyproject.toml:dependencies = []  # TODO: Add dependencies

    pyproject.toml:license = {text = "MIT"}  # TODO: Choose license

    pyproject.toml:name = "minimal_python_project_skeleton"  # TODO: Change package name

    pyproject.toml:  'minimal_python_project_skeleton[test]',  # TODO: Change package name

    pyproject.toml:Changelog = "https://github.com/MArpogaus/minimal_python_project_skeleton/blob/dev/CHANGELOG.md"  # TODO: Change project repo

    pyproject.toml:Documentation = "https://marpogaus.github.io/minimal_python_project_skeleton"  # TODO: Change project repo

    pyproject.toml:Issues = "https://github.com/MArpogaus/minimal_python_project_skeleton/issues"  # TODO: Change project repo

    pyproject.toml:Repository = "https://github.com/MArpogaus/minimal_python_project_skeleton"  # TODO: Change project repo

**Pro-Tipp:** If you later want to update the template, keep a separate branch (i.e. `skeleton`) around and `cherry-pick` the changes you would like to keep for future projects.

This way you can also pull the latest version from upstream and `checkout` the new files you would like to use in your project.



### Installation

This package is available on [PyPI](https://pypi.org/project/minimal-python-project-skeleton/). You install it using pip:

    pip install minimal_python_project_skeleton



## Contributing

Any Contributions are greatly appreciated! If you have a question, an issue or would like to contribute, please read our [contributing guidelines](CONTRIBUTING.md).



## License

Distributed under the [MIT License](LICENSE)



## Contact

[Marcel Arpogaus](https://github.com/MArpogaus/) - [[email protected]](mailto:[email protected]) (encrypted with [ROT13]())

Project Link:



## Acknowledgments

-   README inspired by [othneildrew/Best-README-Template](https://github.com/othneildrew/Best-README-Template)

-   Contribution guidelines inspired by [probabilists/zuko](https://github.com/probabilists/zuko/)

-   Release workflow inspired by [packaging.python.org](https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/)