Sneed-Group/pypush-plus-plus
1
0
Fork 0
mirror of https://github.com/Sneed-Group/pypush-plus-plus synced 2024-12-23 19:32:29 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

small changes to README for clarity

Browse source
This commit is contained in:
Steven Burnham 2023-12-06 22:36:48 -05:00
parent 8379eef5e0
commit 52910fa00f
No known key found for this signature in database
GPG key ID: D765679712A2FC3D
1 changed files with 15 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -5,25 +5,28 @@ It can currently register as a new device on an Apple ID, set up encryption keys
`pypush` is completely platform-independent, and does not require a Mac or other Apple device to use!
## Installation
It's pretty self-explanatory:
Installation is done via pipx:
<!-- TODO: Change the branch upon merge with main -->
<!-- NOTE: Using pip's git support requires that git be installed -->
1. `python3 -m pip install pipx`
2. `python3 -m pipx ensurepath`
3. `pipx install git+https://github.com/JJTech0130/pypush@async`
4. `pypush`
#### Install dependencies
1. `$ python3 -m pip install pipx`
2. `$ python3 -m pipx ensurepath`
#### Install pypush
3. `$ pipx install git+https://github.com/JJTech0130/pypush@async`
#### Run pypush
4. `$ pypush`
### For Developers
1. `git clone -b async https://github.com/JJTech0130/pypush`
2. `cd pypush`
1. `$ git clone -b async https://github.com/JJTech0130/pypush`
2. `$ cd pypush`
3. Install pypush and dependencies
- via pip & requirements.txt (A virtual environment is recommended)
1. `python3 -m pip install -r requirements/requirements.txt`
2. `python3 -m pip install -r requirements/requirements-dev.txt`
3. `python3 -m pip install --editable ./pypush`
1. `$ python3 -m pip install -r requirements/requirements.txt`
2. `$ python3 -m pip install -r requirements/requirements-dev.txt`
3. `$ python3 -m pip install --editable ./pypush`
- via [Poetry](https://python-poetry.org/docs/#installation)
1. `poetry install`
2. `poetry shell`
1. `$ poetry install`
2. `$ poetry shell`
<!-- TODO: Add instructions on adding pypush to PATH(?) -->