Introduction
The especifications for the Transference Protocol is available in this repository.
Installation :floppy_disk:
The package is available at pypi, to be installed from pip with the next command:
pip install tfprotocol_clientA Simple Example :memo:
To use the Transference Protocol through this library, you must create an instance of TfProtocol with the specified parameters and have an online server to connect to.
from tfprotocol_client.misc.constants import RESPONSE_LOGGER
from tfprotocol_client.tfprotocol import TfProtocol
ADDRESS = 'tfproto.expresscuba.com'
PORT = 10345
clienthash = '<clienthash>'
publickey = '<publickey>'
proto = TfProtocol('0.0', publickey, clienthash, ADDRESS, PORT)
proto.connect()
proto.echo_command('Hello World', response_handler=RESPONSE_LOGGER)
proto.disconnect()For Contributors :wrench:
Development Environment Installation :computer:
To set up the development environment, all you need as a prerequisite is to have Python 2.7 or 3.5+ and poetry installed. If you need to install poetry follow these steps and come back.
With this in mind, to install the necessary dependencies and create a python environment for this project, proceed to run the following command in the root directory of the project.
poetry installProject Structure :open_file_folder:
This library is made up of 5 folders and the particular implementations of the TfProtocolSuper class, the folders are structured as follows:
connection: where all socket and low-level communication is located.
models where the complex objects used all over the package are defined.
security where is implemented the methods and classes to encrypt and decrypt the messages for communication and also the utils for do the hashing stuff where is needed.
misc to hold all utils and not related to any other folder concept.
extensions where are all the extensions for the Transfer Protocol Client .
Here the visual schema for all the classes and his relations with others:
Publishing :rocket:
To publish the package you need to run the following command in the root directory of the package:
poetry publish
1 maintainer
Metadata
1 maintainer
Release files for tfprotocol-client 1.2.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| tfprotocol_client-1.2.2.tar.gz | 46.7 kB | Without provenance | Details for tfprotocol_client-1.2.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| tfprotocol_client-1.2.2-py3-none-any.whl | Python 3 | none | any | Details for tfprotocol_client-1.2.2-py3-none-any.whl |
Total release size: 107.6 kB
Release files / tfprotocol_client-1.2.2.tar.gz
| Download URL | tfprotocol_client-1.2.2.tar.gz |
|---|---|
| Size | 46.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
517fd850c036b442b3451c98556199b7c43d0ca092f7a260f27f607c5745020a
|
|
BLAKE2b-256 checksum How to use checksums |
ffbc93363885aff3ea8766e5335fb2f87071ddae527255aecc85c7fa07a9675b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.14
|
Release files / tfprotocol_client-1.2.2-py3-none-any.whl
| Download URL | tfprotocol_client-1.2.2-py3-none-any.whl |
|---|---|
| Size | 60.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6372d2fa94a785b2fc48bcb9509bc24767343d5f34a84125e9a9a3926e866142
|
|
BLAKE2b-256 checksum How to use checksums |
3ab59ba3cdf7d593c3486151d1d252f285d66a8b47e2f9e5017c71ba962fe69e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.14
|
Security for tfprotocol-client 1.2.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
