Skip to content

Commit

Permalink
chore(package): set package to lowercase enacrestic
Browse files Browse the repository at this point in the history
This is to follow PEP 8 naming convention
https://peps.python.org/pep-0008/#package-and-module-names

WIP #20
  • Loading branch information
sbancal committed Jan 26, 2023
1 parent 99e7e4b commit 3cdebe2
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ This has been tested and validated on
```bash
sudo apt install restic python3-pip qt5dxcb-plugin
pip3 install --user --upgrade pip
pip3 install --user ENACrestic
pip3 install --user enacrestic
```

# Upgrade

To upgrade ENACrestic to latest release, just run the following command :

```bash
pip3 install --user --upgrade ENACrestic
pip3 install --user --upgrade enacrestic
```

# Config ENACrestic
Expand Down Expand Up @@ -184,7 +184,7 @@ restic init --password-file ~/.enacrestic/.pw

🎉 Setup is now complete! You're now ready to send your 1st backup. 🎉

# Run `ENACrestic`
# Run `enacrestic`

- from Ubuntu's Application launcher
- or from command line with the single command `enacrestic`
Expand Down
6 changes: 3 additions & 3 deletions README_dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
# Release

1. Check version in `.release-please-manifest.json`
2. `ENACRESTIC_VERSION=$(poetry run python3 setup.py --version) && echo Working on ENACrestic $ENACRESTIC_VERSION`
2. `ENACRESTIC_VERSION=$(poetry run python3 setup.py --version) && echo Working on enacrestic $ENACRESTIC_VERSION`
3. `make package`
4. test new package with `pip install --user dist/ENACrestic-${ENACRESTIC_VERSION}.tar.gz`
4. test new package with `pip install --user dist/enacrestic-${ENACRESTIC_VERSION}.tar.gz`
5. `git commit`
6. `git tag $(python3 setup.py --version)`
7. `git push && git push --tags`
8. `python3 -m twine upload --repository ENACrestic --verbose dist/ENACrestic-${ENACRESTIC_VERSION}*`
8. `python3 -m twine upload --repository enacrestic --verbose dist/enacrestic-${ENACRESTIC_VERSION}*`
2 changes: 1 addition & 1 deletion enacrestic/const.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
# Package related
VERSION_INFO = tuple(map(lambda x: int(x), __version__.split(".")))

PYPI_PROJECT_URL = "https://pypi.org/pypi/ENACrestic/json"
PYPI_PROJECT_URL = "https://pypi.org/pypi/enacrestic/json"
UPGRADE_DOC = "https://github.com/EPFL-ENAC/ENACrestic#upgrade"
DEF_CHECK_NEW_VERSION_EVERY_N_DAYS = 7

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[tool.poetry]
name = "ENACrestic"
name = "enacrestic"
homepage = "https://github.com/EPFL-ENAC/ENACrestic#readme"
repository = "https://github.com/EPFL-ENAC/ENACrestic"
version = "0.5.1"
Expand Down
2 changes: 1 addition & 1 deletion release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"plugins": [
{
"type": "linked-versions",
"group-name": "ENACrestic",
"group-name": "enacrestic",
"components": ["root"]
}
]
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Everything to package ENACrestic
Everything to package enacrestic
Based on:
+ https://packaging.python.org/tutorials/packaging-projects/
Expand Down

0 comments on commit 3cdebe2

Please sign in to comment.