-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from billsioros/development
chore: 🎂🎉 Initial Release 🎂🎉
- Loading branch information
Showing
45 changed files
with
3,257 additions
and
308 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # This CODEOWNERS file is only to make sure that @{{cookiecutter.github_user}} is requested | ||
| # This CODEOWNERS file is only to make sure that @billsioros is requested | ||
| # for a code review in case of a pull request. | ||
|
|
||
| * @{{cookiecutter.github_user}} | ||
| * @billsioros |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| custom: ['https://www.buymeacoffee.com/{{cookiecutter.github_user}}'] | ||
| custom: ['https://www.buymeacoffee.com/billsioros'] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Q&A | ||
| url: https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/discussions/categories/q-a | ||
| url: https://github.com/billsioros/cookiecutter-pypackage/discussions/categories/q-a | ||
| about: Please ask and answer questions here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,96 +1,64 @@ | ||
|  | ||
| # 🍪 Python Cookiecutter 🍪 | ||
|
|
||
| <p align="center"> | ||
| <a href="https://www.python.org/"> | ||
| <a href="https://github.com/billsioros/cookiecutter-pypackage/actions/workflows/ci.yml"> | ||
| <img | ||
| src="https://img.shields.io/pypi/pyversions/{{cookiecutter.project_name}}" | ||
| alt="PyPI - Python Version" | ||
| /> | ||
| </a> | ||
| <a href="https://pypi.org/project/{{cookiecutter.project_name}}/"> | ||
| <img | ||
| src="https://img.shields.io/pypi/v/{{cookiecutter.project_name}}" | ||
| alt="PyPI" | ||
| /> | ||
| </a> | ||
| <a href="https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/actions/workflows/ci.yml"> | ||
| <img | ||
| src="https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/actions/workflows/ci.yml/badge.svg" | ||
| src="https://github.com/billsioros/cookiecutter-pypackage/actions/workflows/ci.yml/badge.svg" | ||
| alt="CI" | ||
| /> | ||
| </a> | ||
| <a href="https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/actions/workflows/cd.yml"> | ||
| <a href="https://github.com/billsioros/cookiecutter-pypackage/actions/workflows/cd.yml"> | ||
| <img | ||
| src="https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/actions/workflows/cd.yml/badge.svg" | ||
| src="https://github.com/billsioros/cookiecutter-pypackage/actions/workflows/cd.yml/badge.svg" | ||
| alt="CI" | ||
| /> | ||
| </a> | ||
| <a href="https://results.pre-commit.ci/latest/github/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/master"> | ||
| <a href="https://results.pre-commit.ci/latest/github/billsioros/cookiecutter-pypackage/master"> | ||
| <img | ||
| src="https://results.pre-commit.ci/badge/github/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/master.svg" | ||
| src="https://results.pre-commit.ci/badge/github/billsioros/cookiecutter-pypackage/master.svg" | ||
| alt="pre-commit.ci status" | ||
| /> | ||
| </a> | ||
| <a href="https://codecov.io/gh/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}"> | ||
| <img | ||
| src="https://codecov.io/gh/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/branch/master/graph/badge.svg?token=coLOL0j6Ap" | ||
| alt="Test Coverage"/> | ||
| </a> | ||
| <a href="https://opensource.org/licenses/MIT"> | ||
| <a href="https://codecov.io/gh/billsioros/cookiecutter-pypackage"> | ||
| <img | ||
| src="https://img.shields.io/pypi/l/{{cookiecutter.project_name}}" | ||
| alt="PyPI - License" | ||
| src="https://codecov.io/gh/billsioros/cookiecutter-pypackage/branch/master/graph/badge.svg?token=coLOL0j6Ap" | ||
| alt="Test Coverage" | ||
| /> | ||
| </a> | ||
| <a href="https://gitpod.io/from-referrer/"> | ||
| <a href="https://opensource.org/licenses/MIT"> | ||
| <img | ||
| src="https://img.shields.io/badge/Gitpod-Open-blue?logo=gitpod" | ||
| alt="Open on Gitpod" | ||
| src="https://img.shields.io/github/license/billsioros/cookiecutter-pypackage" | ||
| alt="GitHub" | ||
| /> | ||
| </a> | ||
| </p> | ||
|
|
||
| ## Example Usage | ||
| ## Quickstart | ||
|
|
||
| Install the latest Cookiecutter | ||
|
|
||
| ```python | ||
| >>> from {{cookiecutter.project_name}} import {{cookiecutter.project_name}}, Track | ||
| >>> with {{cookiecutter.project_name}}(SPOTIFY_ID, SPOTIFY_SECRET): | ||
| >>> result = next(Track.search("SAINt JHN 5 Thousand Singles", limit=1)) | ||
| >>> result | ||
| <Track "SAINt JHN - 5 Thousand Singles"> | ||
| >>> result.url | ||
| 'https://open.spotify.com/track/0fFWxRZGKR7HDW2xBMOZgW' | ||
| >>> result.download("SAINt JHN - 5 Thousand Singles.mp3") | ||
| PosixPath('SAINt JHN - 5 Thousand Singles.mp3') | ||
| ``` | ||
| pip install -U cookiecutter | ||
| ``` | ||
|
|
||
| Feel free to check the [examples](https://github.com/{{cookiecutter.github_user}}/{{cookiecutter.project_name}}/tree/master/examples) folder for more use cases! | ||
| and generate a `Python` package project: | ||
|
|
||
| ``` | ||
| cookiecutter gh:billsioros/cookiecutter-pypackage | ||
| ``` | ||
|
|
||
| ## Features | ||
|
|
||
| - Searching for | ||
| - Tracks | ||
| - Playlists | ||
| - Albums | ||
| - Downloading | ||
| - Tracks | ||
| - Playlists | ||
| - Albums | ||
| - TODO | ||
|
|
||
| ## Documentation | ||
|
|
||
| The project's documentation can be found [here](https://{{cookiecutter.github_user}}.github.io/{{cookiecutter.project_name}}/). | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| pip install {{cookiecutter.project_name}} | ||
| ``` | ||
| The project's documentation can be found [here](https://billsioros.github.io/cookiecutter-pypackage/). | ||
|
|
||
| ## Supporting the project | ||
|
|
||
| Feel free to [**Buy me a coffee! ☕**](https://www.buymeacoffee.com/{{cookiecutter.github_user}}). | ||
| Feel free to [**Buy me a coffee! ☕**](https://www.buymeacoffee.com/billsioros). | ||
|
|
||
| ## Contributing | ||
|
|
||
| If you would like to contribute to the project, please go through the [Contributing Guidelines](https://{{cookiecutter.github_user}}.github.io/{{cookiecutter.project_name}}/latest/CONTRIBUTING/) first. | ||
| If you would like to contribute to the project, please go through the [Contributing Guidelines](https://billsioros.github.io/cookiecutter-pypackage/latest/CONTRIBUTING/) first. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| { | ||
| "project_name": "cookiecutter-pypackage", | ||
| "package_name": "{{ cookiecutter.project_name.replace('-', '_') }}", | ||
| "friendly_name": "{{ cookiecutter.project_name.replace('-', ' ').title() }}", | ||
| "author": "{{cookiecutter.author}}", | ||
| "email": "{{cookiecutter.github_user}}97@gmail.com", | ||
| "github_user": "{{cookiecutter.github_user}}", | ||
| "project_description": "🐍 An awesome python package by the name `{{ cookiecutter.friendly_name }}`", | ||
| "author": "Vasilis Sioros", | ||
| "email": "billsioros97@gmail.com", | ||
| "github_user": "billsioros", | ||
| "version": "0.0.0", | ||
| "license": ["MIT", "Apache-2.0", "GPL-3.0"] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| --8<-- "CHANGELOG.md" |
Oops, something went wrong.