autodiscovery


Nameautodiscovery JSON
Version 0.0.2 PyPI version JSON
download
home_pagehttps://github.com/Michael-Jalloh/Autodiscovery
Summaryautodiscovery is a Python library that simplifies the discovery of Python applications on a network, allowing seamless connection and interaction between services with minimal configuration.
upload_time2024-12-10 22:46:36
maintainerNone
docs_urlNone
authorMichael Jalloh
requires_pythonNone
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # autodiscovery

`autodiscovery` is a Python library designed to facilitate the discovery of Python applications across a network. This tool makes it easy to locate and interact with other instances of Python-based services or applications within a defined network range.

## Features
- **Seamless autodiscovery**: Automatically detects Python applications on the same network.
- **Lightweight and easy to use**: Minimal setup required.
- **Cross-platform**: Works on Windows, macOS, and Linux.

---

## Installation

Install `autodiscovery` via pip:

```bash
pip install autodiscovery
```

---

## Quick Start

Here’s how to get started with `autodiscovery` in your Python application:

### Setting Up a Discoverable Application


```python
from autodiscovery import AutoDiscovery

auto = AutoDiscovery()
auto.run_announcement()
```

### Discovering Applications on the Network

```python
from autodiscovery import AutoDiscovery

auto = AutoDiscovery()
auto.run_announcement()

print(auto.peers)
```
```
{"127.0.0.1": 1733868108.392893}
```
Peers are removed after 10 seconds when the peer stops broadcasting

---



## Example Use Case

### Use Case: Connecting Microservices
Imagine you have a distributed system with multiple microservices running in your local network. Using `autodiscovery`, you can:

1. Start a `AutoDiscovery` announcement in each microservice to announce its presence.
2. Use a `AutoDiscovery` discovery in your central service to find and communicate with all active microservices.

---

## Contributing

Contributions are welcome! If you'd like to contribute to `autodiscovery`, please:

1. Fork the repository on GitHub.
2. Create a new feature branch.
3. Commit your changes and submit a pull request.

---

## License

`autodiscovery` is licensed under the MIT License. See the LICENSE file for details.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Michael-Jalloh/Autodiscovery",
    "name": "autodiscovery",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Michael Jalloh",
    "author_email": "michaeljalloh19@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/a1/94/3458be11f82842ebab93c5291907990cf4a1e8f541eead72e14adfb61dbe/autodiscovery-0.0.2.tar.gz",
    "platform": "any",
    "description": "# autodiscovery\n\n`autodiscovery` is a Python library designed to facilitate the discovery of Python applications across a network. This tool makes it easy to locate and interact with other instances of Python-based services or applications within a defined network range.\n\n## Features\n- **Seamless autodiscovery**: Automatically detects Python applications on the same network.\n- **Lightweight and easy to use**: Minimal setup required.\n- **Cross-platform**: Works on Windows, macOS, and Linux.\n\n---\n\n## Installation\n\nInstall `autodiscovery` via pip:\n\n```bash\npip install autodiscovery\n```\n\n---\n\n## Quick Start\n\nHere\u2019s how to get started with `autodiscovery` in your Python application:\n\n### Setting Up a Discoverable Application\n\n\n```python\nfrom autodiscovery import AutoDiscovery\n\nauto = AutoDiscovery()\nauto.run_announcement()\n```\n\n### Discovering Applications on the Network\n\n```python\nfrom autodiscovery import AutoDiscovery\n\nauto = AutoDiscovery()\nauto.run_announcement()\n\nprint(auto.peers)\n```\n```\n{\"127.0.0.1\": 1733868108.392893}\n```\nPeers are removed after 10 seconds when the peer stops broadcasting\n\n---\n\n\n\n## Example Use Case\n\n### Use Case: Connecting Microservices\nImagine you have a distributed system with multiple microservices running in your local network. Using `autodiscovery`, you can:\n\n1. Start a `AutoDiscovery` announcement in each microservice to announce its presence.\n2. Use a `AutoDiscovery` discovery in your central service to find and communicate with all active microservices.\n\n---\n\n## Contributing\n\nContributions are welcome! If you'd like to contribute to `autodiscovery`, please:\n\n1. Fork the repository on GitHub.\n2. Create a new feature branch.\n3. Commit your changes and submit a pull request.\n\n---\n\n## License\n\n`autodiscovery` is licensed under the MIT License. See the LICENSE file for details.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "autodiscovery is a Python library that simplifies the discovery of Python applications on a network, allowing seamless connection and interaction between services with minimal configuration.",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/Michael-Jalloh/Autodiscovery",
        "issues": "https://github.com/Michael-Jalloh/Autodiscovery/issues",
        "source": "https://github.com/Michael-Jalloh/Autodiscovery"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5b216ab5b2d07eec2c1a70236f0966bec9b08da037f0081725027b3c3450732d",
                "md5": "c5635b295207d64ef56ef2fa9f797474",
                "sha256": "262c33fc85dc808dd2a852f643567e54014bbad1b68e39a06b2d40d2c8f8e038"
            },
            "downloads": -1,
            "filename": "autodiscovery-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c5635b295207d64ef56ef2fa9f797474",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 3820,
            "upload_time": "2024-12-10T22:46:34",
            "upload_time_iso_8601": "2024-12-10T22:46:34.091101Z",
            "url": "https://files.pythonhosted.org/packages/5b/21/6ab5b2d07eec2c1a70236f0966bec9b08da037f0081725027b3c3450732d/autodiscovery-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a1943458be11f82842ebab93c5291907990cf4a1e8f541eead72e14adfb61dbe",
                "md5": "3864b1dedb51764ffc6ee8dbbd804b04",
                "sha256": "2f4e3d21fbbc4b8ed920f302fc95002452dc8ffa14ddcee78e2b763789b6854d"
            },
            "downloads": -1,
            "filename": "autodiscovery-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "3864b1dedb51764ffc6ee8dbbd804b04",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3787,
            "upload_time": "2024-12-10T22:46:36",
            "upload_time_iso_8601": "2024-12-10T22:46:36.717245Z",
            "url": "https://files.pythonhosted.org/packages/a1/94/3458be11f82842ebab93c5291907990cf4a1e8f541eead72e14adfb61dbe/autodiscovery-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-10 22:46:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Michael-Jalloh",
    "github_project": "Autodiscovery",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "autodiscovery"
}
        
Elapsed time: 1.81519s