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

replace pip3 with pip in install instructions

This commit is contained in:
Hugh Rundle 2020-09-08 20:00:34 +10:00
parent dec1232f47
commit d52fb4f408
3 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/index.md
View File

@ -4,14 +4,14 @@
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.
These instructions use the command `pip` - depending on your setup you may need to use `pip3` instead.
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.
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)
* [Options](./options.md)
* [Upgrading and uninstalling](./upgrade.md)
* [Contributing](./contributing.md)
* [Installation](install.md)
* [Options](options.md)
* [Upgrading and uninstalling](upgrade.md)
* [Contributing](contributing.md)
## Prior work
The initial `ephemetoot` script was based on [this tweet-deleting script](https://gist.github.com/flesueur/bcb2d9185b64c5191915d860ad19f23f) by [@flesueur](https://github.com/flesueur)

6
docs/install.md
View File

@ -4,17 +4,17 @@
You need to [install Python 3](https://wiki.python.org/moin/BeginnersGuide/Download) to use `ephemetoot`. Python 2 is now end-of-life, however it continued to be installed as the default Python on MacOS and many Linux distributions until very recently, so you should check.
These instructions use the command `pip3` since it is very likely you will need to use that instead of `pip` (which usually points to Python 2). On some systems you may need to use `pip` instead, if `pip` is pointing to Python 3.
These instructions use the command `pip` - depending on your setup you may need to use `pip3` instead.
## Install ephemetoot from pypi
```shell
pip3 install ephemetoot
pip install ephemetoot
```
If you do not have permission to install python modules, you may need to use the `--user` flag. Generally this is not advisable, since you will need to run ephemetoot with the same user since it will only be installed for that user and not globally:
```shell
pip3 install ephemetoot --user
pip install ephemetoot --user
```
## Obtain an access token

14
docs/upgrade.md
View File

@ -7,16 +7,16 @@
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
2. run `pip3 uninstall ephemetoot`
3. run `pip3 install ephemetoot`
2. run `pip uninstall ephemetoot`
3. run `pip install ephemetoot`
4. check your config file is in the current directory
5. check everything is working with `ephemetoot --test` or `ephemetoot --version`
### 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:
```shell
pip3 install --upgrade ephemetoot
pip install --upgrade ephemetoot
```
### Upgrading with git
@ -25,7 +25,7 @@ To upgrade to a new version using git, run the following from inside the `epheme
```shell
git fetch --tags
git checkout [latest-tagname]
pip3 install .
pip install .
```
### Upgrading with a ZIP file
@ -34,13 +34,13 @@ To upgrade without using git or pypi:
* put your config file somewhere safe
* 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
* run `pip3 install .` from within the directory
* run `pip install .` from within the directory
## Uninstalling
Uninstall using pip:
```shell
pip3 uninstall ephemetoot
pip uninstall ephemetoot
```
If you scheduled a `launchd` job on MacOS using `--schedule`, you will also need to unload and remove the scheduling file: