Skip to content

Commit

Permalink
pypush: prepare for PyPI!
Browse files Browse the repository at this point in the history
  • Loading branch information
JJTech0130 committed May 21, 2024
1 parent ce88a8e commit 09090b5
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
> [!WARNING]
> `pypush` is undergoing a major rewrite. The current version is not stable and may not work as expected.
> `pypush` is undergoing a major rewrite. The current version is not stable and may not work as expected. Many features have been temporarily removed.
>
> Versioning starts at 2.0.0 due to conflicts with the original package to have the `pypush` name. Do not expect stability until 3.0.0.
# pypush
`pypush` is a POC demo of my recent iMessage reverse-engineering.
It can currently register as a new device on an Apple ID, set up encryption keys, and ***send and receive iMessages***!
`pypush` was originally a POC demo of my recent iMessage reverse-engineering.
It is now being developed into a community library aiming to cover all of Apple's internal API surface.

`pypush` is completely platform-independent, and does not require a Mac or other Apple device to use!
Currently, the rewritten version supports using the client side of Apple's internal APNs API, meaning it can activate as an
Apple device and receive push notifications. Stay tuned for future updates as we bring back the iMessage API and more!

`pypush` is completely platform-independent, though it may require device identifiers to use some APIs.

## Installation
Simple installation:
```bash
pip install git+https://github.com/JJTech0130/pypush
pip install pypush[cli]
```
Editable installation (for development):
```bash
Expand Down
20 changes: 20 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@ build-backend = "setuptools.build_meta"
[project]
name = "pypush"
dynamic = ["version"]
authors = [
{ name = "JJTech", email = "jjtech@jjtech.dev" },
]
description = "Interact with Apple Private API"

readme = "README.md"
requires-python = ">=3.9"
classifiers = [
"Programming Language :: Python :: 3",
"Development Status :: 3 - Alpha",
"Operating System :: OS Independent",
"License :: Other/Proprietary License",
]
license = {text = "Server Side Public License (SSPL)"}
keywords = ["apple", "api", "reverse engineering", "imessage", "apns"]

dependencies = [
"anyio",
"httpx",
Expand All @@ -14,6 +30,10 @@ dependencies = [
'importlib_metadata; python_version>="3.9"',
]

[project.urls]
Homepage = "https://github.com/JJTech0130/pypush"
Issues = "https://github.com/JJTech0130/pypush/issues"

[project.scripts]
pypush = "pypush.cli:main"

Expand Down

0 comments on commit 09090b5

Please sign in to comment.