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

adjust installation instructions

Browse source
This commit is contained in:
Cypheriel 2023-11-19 14:57:08 -07:00
parent c0c7bbde5e
commit ea03ceda6b
No known key found for this signature in database
1 changed files with 21 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
README.md
View file

@ -5,10 +5,27 @@ 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:
1. `git clone https://github.com/JJTech0130/pypush`
2. `pip3 install -r requirements.txt`
3. `python3 ./demo.py`
It's pretty self-explanatory:
<!-- 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/beeper/pypush@async`
4. `pypush`
### For Developers
1. `git clone -b async https://github.com/beeper/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`
- via [Poetry](https://python-poetry.org/docs/#installation)
1. `poetry install`
2. `poetry shell`
<!-- TODO: Add instructions on adding pypush to PATH(?) -->
## Troubleshooting
If you have any issues, please join [the Discord](https://discord.gg/BVvNukmfTC) and ask for help.