PyRoll Plugin
Template for PyRoll Plugin Repositories.
Please follow the following instructions when creating your own PyRoll plugins:
-
The folder
pyrollis a namespace package, place your plugin package therein to make it discoverable by the CLI for example by just renaming the nestedpluginpackage to the desired). -
Use
pytestfor creating unit tests. Place all test files in thetestsfolder. -
Update the
pyproject.tomlwith your metadata. It is recommended to usehatchto maintain dependencies, as is preconfigured. It is recommended that the plugin major version corresponds to the PyRoll Core major version (so plugin versions 2.x.x working withpyroll-core2.x.x). -
Place documentation in the
docsfolder:- you may provide a printable documentation using LaTeX based on the
docs.textemplate and the providedPyRollDocsclass - you may provide a web documentation using Markdown or RST rendered by GitHub or external tools like Sphinx
- you may provide a printable documentation built from Markdown or RST by tools such as Pandoc
- if appropriate, include the result PDF in the commit and link it from
README.mdlike so - include model and usage information in the documentation
- you may provide a printable documentation using LaTeX based on the
-
Please use a permissive license such as BSD or MIT
-
Edit this readme file with contents of your own needs.
-
If you want your plugin to be listed on the main documentation website (see here), please contact the maintainers preferably using an issue or PR.
Usage of the Preconfigured Hatch Scripts
To build the docs use (needs a working LaTeX installation)
hatch run docs:build
To run the tests use
hatch run test:all
The test environment is preconfigured to test with Python 3.9, 3.10 and 3.11. The tests are skipped for the respective version, if it can not be found.
Metadata
Release files for pyroll-mauk-gottschling-flow-stress 3.0.0
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 |
|---|---|---|---|---|
| pyroll_mauk_gottschling_flow_stress-3.0.0.tar.gz | 5.2 kB | Without provenance | Details for pyroll_mauk_gottschling_flow_stress-3.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyroll_mauk_gottschling_flow_stress-3.0.0-py3-none-any.whl | Python 3 | none | any | Details for pyroll_mauk_gottschling_flow_stress-3.0.0-py3-none-any.whl |
Total release size: 10.3 kB
Release files / pyroll_mauk_gottschling_flow_stress-3.0.0.tar.gz
| Download URL | pyroll_mauk_gottschling_flow_stress-3.0.0.tar.gz |
|---|---|
| Size | 5.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
71c1afeac95c651117734464e44d8562f49a470462758dbab9b8636acb329f48
|
|
BLAKE2b-256 checksum How to use checksums |
ed2e878bcc545ac7f2411c8c4f640aae9f3a46365acf8d2bab0d07011fc46aef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.27.2
|
Release files / pyroll_mauk_gottschling_flow_stress-3.0.0-py3-none-any.whl
| Download URL | pyroll_mauk_gottschling_flow_stress-3.0.0-py3-none-any.whl |
|---|---|
| Size | 5.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a1bc557d500902f13ac09ad12f130a9e4926bf310645c5757f5e092d9f86366a
|
|
BLAKE2b-256 checksum How to use checksums |
827bae841435688388fc83874d9cf4e2ea4e22811ef9e818562efa9b29bec12d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
python-httpx/0.27.2
|
Security for pyroll-mauk-gottschling-flow-stress 3.0.0
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.