The package fastrpi is the client to interact with the FastrPI, the Fastr Package Index, where Fastr Networks, Tools and Datatypes are gathered to use with Fastr. In the FastrPI repository the Fastr Network, Tool and Datatype definitions are stored, as well as Dockerized versions of the Fastr Tools. By using the FastrPI client the networks can easily be retrieved and run using either Docker or Singularity.
The code can be found on Gitlab and the documentation is available through ReadTheDocs.
The FastrPI repository itself is currently not open to the public.
Install
To use fastrpi it is necessary to have Git (>=1.7.0) installed and either Docker or Singularity. Install and set up FastrPI by running: .. codeblock:
pip install fastrpi fastrpi init
During the initialization process you will be guided through the setup process. To use the private repository and to publish packages you will need to set an SSH connection with GitLab and have a GitLab API token. See the documentation for more information.
Usage
The fastrpi package can be used to install, run, create, edit and publish Fastr Tools and Networks. Here is a quick introduction to installing and running a network.
Before you can run a Network it needs to be installed. You can do so by using:
fastrpi install network network_name -v versionDuring the installation of this network the necessary Tools will also be installed. With this installation the Docker containers associated with these Tools will also be pulled using either Docker or Singularity. The available Networks and Tools in the FastrPI repository can be viewed using fastrpi list networks and fastrpi list tools.
After installing a Network it can be run using:
fastrpi run network_name -v version --source_sink ./source_sink.pyThe file ./source_sink.py must contain the functions get_source_data() and get_sink_data(). These functions must return dictionaries containing the Sources and Sinks, as described here.
Further information about the functionality of FastrPI can be found in the documentation.
Known issues
The package is not yet tested on Windows.
2 maintainers
Metadata
2 maintainers
Release files for fastrpi 1.0.1
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 |
|---|---|---|---|---|
| fastrpi-1.0.1.tar.gz | 46.4 kB | Without provenance | Details for fastrpi-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| fastrpi-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for fastrpi-1.0.1-py3-none-any.whl |
Total release size: 104.0 kB
Release files / fastrpi-1.0.1.tar.gz
| Download URL | fastrpi-1.0.1.tar.gz |
|---|---|
| Size | 46.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8eaac700c6e4f68bb8fe45b20d629ae7e6ea2fbd46e1f3de8df3881ec6bd4663
|
|
BLAKE2b-256 checksum How to use checksums |
4c9a7adb793d8beaba6569d7734b8e4195c5cb4442d9d50874c9d6064c76bc45
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.15
|
Release files / fastrpi-1.0.1-py3-none-any.whl
| Download URL | fastrpi-1.0.1-py3-none-any.whl |
|---|---|
| Size | 57.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
98c693d5772d47786b22f5d9437fd2ee1e265ff19d267ee2915cebafa2715848
|
|
BLAKE2b-256 checksum How to use checksums |
dfdf92ae181c0c8d76f729a7edf9ee58a33664c6066f4a647e7332628f4993c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.10.15
|
Security for fastrpi 1.0.1
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.
