Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
MArpogaus committed Feb 16, 2024
2 parents 76f2079 + 402e496 commit 6bec502
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 19 deletions.
34 changes: 18 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[![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)

Expand All @@ -12,16 +13,16 @@

# Minimal Python Project Skeleton

1. [About The Project](#orgec9657a)
2. [Getting Started](#orgddff7eb)
1. [Installation](#orgcbc7cfb)
3. [Contributing](#org259be4a)
4. [License](#org0f6c619)
5. [Contact](#orge69fd4c)
6. [Acknowledgments](#orgc17cb0c)
1. [About The Project](#org7412b7d)
2. [Getting Started](#org6b6d8e8)
1. [Installation](#org21da8c1)
3. [Contributing](#org19ccf8c)
4. [License](#org0045bae)
5. [Contact](#org7761778)
6. [Acknowledgments](#org588cc56)


<a id="orgec9657a"></a>
<a id="org7412b7d"></a>

## About The Project

Expand Down Expand Up @@ -51,7 +52,7 @@ This folder structure should act as a simple starting point for your next python
It contains just the minimum to get you started with a ready configured GitHub actions for automated [linting](<https://github.com/MArpogaus/minimal-python-project-skeleton/blob/main/.github/workflows/pre-commit.yaml>), [testing](<https://github.com/MArpogaus/minimal-python-project-skeleton/blob/main/.github/workflows/test.yaml>), and [releasing](<https://github.com/MArpogaus/minimal-python-project-skeleton/blob/main/.github/workflows/release.yaml>) on PiPy.


<a id="orgddff7eb"></a>
<a id="org6b6d8e8"></a>

## Getting Started

Expand All @@ -61,7 +62,7 @@ Use this template directly to [create a new GitHub repository](<https://github.c
This way you can also pull the latest version from upstream and `checkout` the new files you would like to use in your project.


<a id="orgcbc7cfb"></a>
<a id="org21da8c1"></a>

### Installation

Expand All @@ -70,33 +71,34 @@ This package is available on [PyPI](https://pypi.org/project/minimal-python-proj
pip install minimal_python_project_skeleton


<a id="org259be4a"></a>
<a id="org19ccf8c"></a>

## 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).


<a id="org0f6c619"></a>
<a id="org0045bae"></a>

## License

Distributed under the [MIT License](LICENSE)


<a id="orge69fd4c"></a>
<a id="org7761778"></a>

## Contact

[Marcel Arpogaus](https://github.com/MArpogaus/) - [znepry.necbtnhf@tznvy.pbz](mailto:znepry.necbtnhf@tznvy.pbz)
[Marcel Arpogaus](https://github.com/MArpogaus/) - [znepry.necbtnhf@tznvy.pbz](mailto:znepry.necbtnhf@tznvy.pbz) (encrypted with [ROT13](<https://rot13.com/>))

Project Link:
<https://github.com/MArpogaus/python-project-skeleton>


<a id="orgc17cb0c"></a>
<a id="org588cc56"></a>

## 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/)
- 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/)
6 changes: 4 additions & 2 deletions README.org
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
[[https://github.com/MArpogaus/python-project-skeleton/issues][https://img.shields.io/github/issues/MArpogaus/python-project-skeleton.svg?style=flat-square]]
[[https://github.com/MArpogaus/python-project-skeleton/blob/main/LICENSE][https://img.shields.io/github/license/MArpogaus/python-project-skeleton.svg?style=flat-square]]
[[https://github.com/MArpogaus/python-project-skeleton/actions/workflows/test.yaml][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/release.yaml][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/blob/main/.pre-commit-config.yaml][https://img.shields.io/badge/pre--commit-enabled-brightgreen.svg?logo=pre-commit&style=flat-square]]
[[https://linkedin.com/in/MArpogaus][https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555]]

Expand Down Expand Up @@ -74,12 +75,13 @@ Distributed under the [[file:LICENSE][MIT License]]

** Contact

[[https://github.com/MArpogaus/][Marcel Arpogaus]] - [[mailto:znepry.necbtnhf@tznvy.pbz][znepry.necbtnhf@tznvy.pbz]]
[[https://github.com/MArpogaus/][Marcel Arpogaus]] - [[mailto:znepry.necbtnhf@tznvy.pbz][znepry.necbtnhf@tznvy.pbz]] (encrypted with [ROT13](https://rot13.com/))

Project Link:
[[https://github.com/MArpogaus/python-project-skeleton]]

** Acknowledgments

- README inspired by [[https://github.com/othneildrew/Best-README-Template][othneildrew/Best-README-Template]]
- Contribution guidelines inspired by [[https://github.com/probabilists/zuko/][probabilists/zuko:]]
- Contribution guidelines inspired by [[https://github.com/probabilists/zuko/][probabilists/zuko]]
- Release workflow inspired by [[https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/][packaging.python.org]]
2 changes: 1 addition & 1 deletion src/minimal_python_project_skeleton/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
__version__ = "0.0.1"
__version__ = "0.0.2"


def func(x):
Expand Down

0 comments on commit 6bec502

Please sign in to comment.