Skip to main content

Everything you need to work with Apple's Find My network!

Project description

FindMy.py

The all-in-one library that provides everything you need to query Apple's FindMy network!

The current "Find My-scene" is quite fragmented, with code being all over the place across multiple repositories, written by several authors. This project aims to unify this scene, providing common building blocks for any application wishing to integrate with the Find My network.

[!IMPORTANT] This project is currently in Alpha. While existing functionality will likely not change much, the API design is subject to change without prior warning.

You are encouraged to report any issues you can find on the issue tracker!

Features

  • Cross-platform: no Mac needed
  • Fetch location reports
    • Apple acount sign-in
    • SMS 2FA support
  • Scan for nearby FindMy-devices
    • Decode their info, such as public keys and status bytes
  • Import or create your own accessory keys
  • Both async and sync APIs

Roadmap

  • Trusted device 2FA
    • Work has been done, but needs testing (I don't own any Apple devices)
  • Local anisette generation (without server)
    • Can be done using pyprovision, however I want to wait until Python wheels are available.

Installation

The package can be installed from PyPi:

pip install findmy

For usage examples, see the examples directory. Documentation coming soon™.

Contributing

Want to contribute code? That's great! For new features, please open an issue first so we can discuss.

This project uses Ruff for linting and formatting. Before opening a pull request, please ensure that your code adheres to these rules. There are pre-commit hooks included to help you with this, which you can set up as follows:

pip install poetry ruff
poetry install  # this installs pre-commit into your environment
pre-commit install

After following the above steps, your code will be linted and formatted automatically before committing it.

Credits

While I designed the library, the vast majority of actual functionality is made possible by the following wonderful people and organizations:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

findmy-0.3.1.tar.gz (19.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

findmy-0.3.1-py3-none-any.whl (22.6 kB view details)

Uploaded Python 3

File details

Details for the file findmy-0.3.1.tar.gz.

File metadata

  • Download URL: findmy-0.3.1.tar.gz
  • Upload date:
  • Size: 19.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1018-azure

File hashes

Hashes for findmy-0.3.1.tar.gz
Algorithm Hash digest
SHA256 2acfbc85e22792557f09e7df15b03d81565f1900b11d6bc895901ebf5a74388b
MD5 f92bf5f8b92db7184762ef2518c4d106
BLAKE2b-256 1fff837b66589f11db230697213bdbf439cde8422b8ac118325f0c680a8344b7

See more details on using hashes here.

File details

Details for the file findmy-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: findmy-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 22.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.13 Linux/6.2.0-1018-azure

File hashes

Hashes for findmy-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 abaec50f4a7eb3d54ca1bfab210a865e5462a8319d885b8fd12aa3b3933d8283
MD5 5d2f335b01c9803344723ee3ed85f760
BLAKE2b-256 12e28cb9fe81309ce3ac92fc5be027b0ed33a5c7d1655c3cc01a71444340a18b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page