Skip to content

Commit

Permalink
Merge branch 'main' into update-repo-url
Browse files Browse the repository at this point in the history
# Conflicts:
#	.github/workflows/release.yml
#	docs/installation.md
  • Loading branch information
cunla committed Dec 15, 2024
2 parents 5cf1f01 + aaa5544 commit 5a43c6c
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ on: push

env:
# Change these for your project's URLs
PYPI_URL: https://pypi.org/p/best-practices
PYPI_TEST_URL: https://test.pypi.org/p/best-practices
PYPI_URL: https://pypi.org/p/django-commons-best-practices
PYPI_TEST_URL: https://test.pypi.org/p/django-commons-best-practices

jobs:

Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Django Commons Playground Code of Conduct
# Code of Conduct

The best-practices project utilizes the [Django Commons Code of Conduct](https://github.com/django-commons/membership/blob/main/CODE_OF_CONDUCT.md).
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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())
Expand Down
6 changes: 3 additions & 3 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Installation

This section explains how to install `best-practices` 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 `best-practices` (`pip install best-practices`)
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 best-practices
pip install django-commons-best-practices
```
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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" },
Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion tests/test_playground.py
Original file line number Diff line number Diff line change
@@ -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):
Expand Down

0 comments on commit 5a43c6c

Please sign in to comment.