diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 36be2e3..8f00e17 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -4,8 +4,8 @@ on: push env: # Change these for your project's URLs - PYPI_URL: https://pypi.org/p/django-commons-playground - PYPI_TEST_URL: https://test.pypi.org/p/django-commons-playground + PYPI_URL: https://pypi.org/p/django-commons-best-practices + PYPI_TEST_URL: https://test.pypi.org/p/django-commons-best-practices jobs: diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 49048ca..3f69d2d 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,3 +1,3 @@ -# Django Commons Playground Code of Conduct +# Code of Conduct -The django-commons-playground project utilizes the [Django Commons Code of Conduct](https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md). +The best-practices project utilizes the [Django Commons Code of Conduct](https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md). diff --git a/README.md b/README.md index 7277628..e6cfad9 100644 --- a/README.md +++ b/README.md @@ -2,5 +2,5 @@ This is an example repository for Django Commons. Some relevant areas to review are: -- GitHub action ([release.yml](https://github.com/django-commons/django-commons-playground/blob/main/.github/workflows/release.yml)) for releasing to PyPI +- GitHub action ([release.yml](https://github.com/django-commons/best-practices/blob/main/.github/workflows/release.yml)) for releasing to PyPI - [Documentation](docs/README.md) diff --git a/docs/README.md b/docs/README.md index 6cd2e7c..5325f9e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Documentation -The documentation for Django Commons Playground serves as an example for what +The documentation for Django Commons Best Practices serves as an example for what a repository should contain. The structure doesn't have to be exactly the same as this, but it's a starting point. Any docs is better than no docs. Maintained and organized docs are the best docs. diff --git a/docs/contributing.md b/docs/contributing.md index ac3b55e..8ae473b 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,22 +1,22 @@ # Contributing -Everyone is welcome to contribute to `django-commons-playground`. We strictly +Everyone is welcome to contribute to `best-practices`. We strictly enforce our [Code of Conduct](../CODE_OF_CONDUCT.md), so please review it before contributing. ## Getting started -1. [Fork the repository](https://github.com/django-commons/django-commons-playground/fork) -2. Clone your fork of the repository `git clone git@github.com:[YOUR_USERNAME_HERE]/django-commons-playground.git && cd django-commons-playground` +1. [Fork the repository](https://github.com/django-commons/best-practices/fork) +2. Clone your fork of the repository `git clone git@github.com:[YOUR_USERNAME_HERE]/best-practices.git && cd best-practices` 3. Create a venv and activate it `python -m venv venv && source venv/bin/activate` 4. Create a feature branch for your work `git checkout -b relevant-branch-name-here` 5. Implement your changes, run the tests and make a commit to your branch 6. Push your branch to GitHub `git push origin relevant-branch-name-here` -7. Create a [PR on the upstream repo (this repo)](https://github.com/django-commons/django-commons-playground/pulls) +7. Create a [PR on the upstream repo (this repo)](https://github.com/django-commons/best-practices/pulls) ## Architecture -The django-commons-playground is a collection of utility functions with a +The best-practices is a collection of utility functions with a playground theme. The purpose is to serve as an example to inbound repositories. Because of that the documentation, pre-commit configuration and GitHub actions are the most important aspects of the project. The code itself is secondary. @@ -31,7 +31,7 @@ Nothing special here! ## Releasing -The repo is configured to [automatically release to PyPI](https://github.com/django-commons/django-commons-playground/blob/main/.github/workflows/release.yml) +The repo is configured to [automatically release to PyPI](https://github.com/django-commons/best-practices/blob/main/.github/workflows/release.yml) when a new tag is pushed to GitHub. This makes use of [PyPI's trusted publishers](https://docs.pypi.org/trusted-publishers/). ### Manual releases diff --git a/docs/getting_started.md b/docs/getting_started.md index 441b209..babadf4 100644 --- a/docs/getting_started.md +++ b/docs/getting_started.md @@ -5,7 +5,7 @@ after [installing the project](installation.md), you can use the functionality as such: ```python -from django_commons_playground import playground +from django_commons_best_practices import playground print(playground.seesaw()) print(playground.seesaw()) diff --git a/docs/installation.md b/docs/installation.md index 84fb372..34ce980 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,16 +1,16 @@ # Installation -This section explains how to install `django-commons-playground` to use within +This section explains how to install `django-commons-best-practices` to use within your project. It assumes you have a working installation of Python 3. 1. Create venv/virtualenv (`python -m venv venv`) 2. Activate venv/virtualenv (`source venv/bin/activate`) -3. Install `django-commons-playground` (`pip install django-commons-playground`) +3. Install `django-commons-best-practices` (`pip install django-commons-best-practices`) All together now: ```shell python -m venv venv source venv/bin/activate -pip install django-commons-playground +pip install django-commons-best-practices ``` diff --git a/pyproject.toml b/pyproject.toml index 5527376..28f24dc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ requires = ["setuptools>=61.0"] build-backend = "setuptools.build_meta" [project] -name = "django_commons_playground" +name = "django-commons-best-practices" version = "1.1.0" authors = [ { name="Tim Schilling", email="schillingt@better-simple.com" }, @@ -22,5 +22,5 @@ keywords = [ ] [project.urls] -Homepage = "https://github.com/django-commons/django-commons-playground" -Issues = "https://github.com/django-commons/django-commons-playground/issues" \ No newline at end of file +Homepage = "https://github.com/django-commons/best-practices" +Issues = "https://github.com/django-commons/best-practices/issues" \ No newline at end of file diff --git a/src/django_community_playground/__init__.py b/src/django_commons_best_practices/__init__.py similarity index 100% rename from src/django_community_playground/__init__.py rename to src/django_commons_best_practices/__init__.py diff --git a/src/django_community_playground/playground.py b/src/django_commons_best_practices/playground.py similarity index 100% rename from src/django_community_playground/playground.py rename to src/django_commons_best_practices/playground.py diff --git a/tests/test_playground.py b/tests/test_playground.py index f10a6b7..b1ebe03 100644 --- a/tests/test_playground.py +++ b/tests/test_playground.py @@ -1,6 +1,6 @@ from unittest import TestCase -from src.django_commons_playground import playground +from src.django_commons_best_practices import playground class TestPlayground(TestCase):