Mastodon
/
ephemetoot-eliminare-vecchi-messaggi
mirror of https://github.com/hughrun/ephemetoot
1
0
Fork 0
Code Issues Releases Wiki Activity

update docs for v3 

Adds more information specific to upgrading from earlier version to v3.x
This commit is contained in:
Hugh Rundle 2020-09-05 17:23:04 +10:00
parent 6ccbd9bdd9
commit aea5c1d0ea
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/index.md
View File

@ -2,7 +2,11 @@
**ephemetoot** is a Python command line tool for deleting old toots. **ephemetoot** is a Python command line tool for deleting old toots.
These docs apply to Version 3. These docs apply to `ephemetoot` version 3.
Note that throughout these docs the `pip` command is referred to as `pip3`. This is to help new Python users on systems running both Python 2 and Python 3, which is currently still common and a frequent source of confusion. On some systems, `pip` will be the appropriate command, as it points to Python 3 environments.
If you are upgrading from an `ephemetoot` version prior to v3.0.0 please see the [upgrading](./upgrade.md) instructions and note that you need to manually uninstall the old version first.
* [Installation](./install.md) * [Installation](./install.md)
* [Options](./options.md) * [Options](./options.md)

12
docs/upgrade.md
View File

@ -2,15 +2,15 @@
## Upgrading ## Upgrading
### Note for users upgrading from Version 2 to Version 3 ### Note for users upgrading to Version 3
To upgrade from Version 2.x to Version 3.x you will need to remove your existing install. To upgrade from an earlier version to Version 3.x you will need to remove your existing install.
1. save a copy of your `config.yaml` file somewhere safe 1. save a copy of your `config.yaml` file somewhere safe
2. run `pip uninstall ephemetoot` 2. run `pip3 uninstall ephemetoot`
3. run `pip install ephemetoot` 3. run `pip3 install ephemetoot`
4. check your config file is in the current directory 4. check your config file is in the current directory
5. do a test run with `ephemetoot --test` 5. check everythign is working with `ephemetoot --test` or `ephemetoot --version`
### Upgrading with pypi ### Upgrading with pypi
To upgrade to a new version, the easiest way is to use pip to download the latest version from pypi (remembering that for your machine you may need to substitute `pip` for `pip3`): To upgrade to a new version, the easiest way is to use pip to download the latest version from pypi (remembering that for your machine you may need to substitute `pip` for `pip3`):
@ -34,7 +34,7 @@ To upgrade without using git or pypi:
* put your config file somewhere safe * put your config file somewhere safe
* download and unzip the zip file into your `ephemetoot` directory over the top of your existing installation * download and unzip the zip file into your `ephemetoot` directory over the top of your existing installation
* move your config file back in to the ephemetoot directory * move your config file back in to the ephemetoot directory
* run `pip install .` from within the directory * run `pip3 install .` from within the directory
## Uninstalling ## Uninstalling