# Address Ping System (APS) for Naruno
Address Ping System (APS) is a tool designed to check the online status of servers associated with blockchain addresses in Naruno. With APS, you can ensure that the servers you want to communicate with are online and reachable before sending any messages or making any transactions.
## Features
- Decentralized system
- Secure communication between nodes
- Fast and easy to use
- Checks online status of servers associated with blockchain addresses
## Installation
You can install APS by pip3:
```console
pip3 install address_ping_system
```
## Usage
*If you want to use address_ping_system you must to use Naruno. For now please checkout the [Baklava Testnet](https://naruno.org/baklava-testnet/).
Getting address of client and server:
```console
narunocli -pw
```
### Server
For a server to be pinged by APS, it needs to have a corresponding APS entry with trusted user addresses set up.
```python
from address_ping_system import aps
my_aps_server = aps("MyNarunoPass")
my_aps_server.add_user("client_address")
my_aps_server.run()
```
also you can use in command line:
```console
aps --password MyNarunoPass --trusted_users ["client_address"] run
```
### Client
To use APS, you can call the aps.ping function with your blockchain address and the server's blockchain address as parameters:
```python
from address_ping_system import aps
my_aps_client = aps("MyNarunoPass")
result = my_aps_client.ping("server_address")
print(result)
my_aps_client.close()
```
also you can use in command line:
```console
aps --password MyNarunoPass ping "server_address"
```
This will return a boolean value indicating whether the server associated with the provided blockchain address is online and reachable.
## Contributing
Contributions to APS are welcome! If you have any suggestions or find a bug, please open an issue on the GitHub repository. If you want to contribute code, please fork the repository and create a pull request.
## License
APS is released under the MPL-2.0 License.
Raw data
{
"_id": null,
"home_page": "https://github.com/Naruno/Address-Ping-System",
"name": "address-ping-system",
"maintainer": "",
"docs_url": null,
"requires_python": ">= 3",
"maintainer_email": "",
"keywords": "",
"author": "Naruno Developers",
"author_email": "onur.atakan.ulusoy@naruno.org",
"download_url": "https://files.pythonhosted.org/packages/3b/d0/c7b82aecafb8bb466b01dfe9a23d0f79a55933bf2ed3c6bbcabcee64024a/address_ping_system-0.5.1.tar.gz",
"platform": null,
"description": "# Address Ping System (APS) for Naruno\nAddress Ping System (APS) is a tool designed to check the online status of servers associated with blockchain addresses in Naruno. With APS, you can ensure that the servers you want to communicate with are online and reachable before sending any messages or making any transactions.\n\n## Features\n- Decentralized system\n- Secure communication between nodes\n- Fast and easy to use\n- Checks online status of servers associated with blockchain addresses\n\n## Installation\nYou can install APS by pip3:\n\n```console\npip3 install address_ping_system\n```\n\n## Usage\n\n*If you want to use address_ping_system you must to use Naruno. For now please checkout the [Baklava Testnet](https://naruno.org/baklava-testnet/).\n\nGetting address of client and server:\n```console\nnarunocli -pw\n```\n\n### Server\nFor a server to be pinged by APS, it needs to have a corresponding APS entry with trusted user addresses set up.\n\n```python\nfrom address_ping_system import aps\n\nmy_aps_server = aps(\"MyNarunoPass\")\n\nmy_aps_server.add_user(\"client_address\")\n\nmy_aps_server.run()\n```\n\nalso you can use in command line:\n```console\t\naps --password MyNarunoPass --trusted_users [\"client_address\"] run\n```\n\n### Client\nTo use APS, you can call the aps.ping function with your blockchain address and the server's blockchain address as parameters:\n\n```python\nfrom address_ping_system import aps\n\nmy_aps_client = aps(\"MyNarunoPass\")\n\nresult = my_aps_client.ping(\"server_address\")\n\nprint(result)\n\nmy_aps_client.close()\n```\n\nalso you can use in command line:\n```console\t\naps --password MyNarunoPass ping \"server_address\"\n```\n\n\nThis will return a boolean value indicating whether the server associated with the provided blockchain address is online and reachable.\n\n## Contributing\nContributions to APS are welcome! If you have any suggestions or find a bug, please open an issue on the GitHub repository. If you want to contribute code, please fork the repository and create a pull request.\n\n## License\nAPS is released under the MPL-2.0 License.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mapping Addresses to Dynamic IPs, Simplified",
"version": "0.5.1",
"project_urls": {
"Homepage": "https://github.com/Naruno/Address-Ping-System"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3bd0c7b82aecafb8bb466b01dfe9a23d0f79a55933bf2ed3c6bbcabcee64024a",
"md5": "a5a38f05c4143dc7a4f8a1fde2f23f23",
"sha256": "6749550e292f14ca98a78e915f4a8237180c2c1e820375025d0885d9948241a3"
},
"downloads": -1,
"filename": "address_ping_system-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "a5a38f05c4143dc7a4f8a1fde2f23f23",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">= 3",
"size": 8567,
"upload_time": "2023-08-02T12:18:05",
"upload_time_iso_8601": "2023-08-02T12:18:05.430931Z",
"url": "https://files.pythonhosted.org/packages/3b/d0/c7b82aecafb8bb466b01dfe9a23d0f79a55933bf2ed3c6bbcabcee64024a/address_ping_system-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-02 12:18:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Naruno",
"github_project": "Address-Ping-System",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "address-ping-system"
}
JSON
