alc-aiidalab-widgets
This is a collection of commonly used widgets used across AiiDAlab plugins developed by the Ada Lovelace Centre (STFC). It provides re-usable components and consistent styling which can be deployed to any new or developing AiiDAlab plugin. It can be installed via pip,
pip install alc-aiidalab-widgets
and then imported within any python project as,
import alc_aiidalab_widgets
For Developers
Style Checking
This package uses pre-commit hooks to check for style consistency, to use these the pre-commit tool is required.
This can be installed alongside the base package by running,
pip install .[dev]
or separately via,
pip install pre-commit
Once installed run,
pre-commit install
in the base repository to enable the pre-commit hooks. This will now run style and formatting checks on every commit.
Testing
This package uses pytest
to run all unit tests which is included in the [dev] optional
package dependencies. Once installed it can be run from the project root directory.
The CI workflows are configured to ensure all tests pass
before a pull request can be accepted into the main repository.
It is important that any new additions to the code base are accompanied
by appropriate testing, maintaining a high code coverage. The coverage
can be checked via,
pytest --cov=aiidalab_alc
Documentation
The documentation, including a User Guide, Developer Guide and an API reference,
is built using sphinx. The source
for which is contained in the docs/ directory. At present
only the html generator has been fully tested. All required packages can
be installed alongside the core package via,
pip install .[docs]
and then the documentation can be built using sphinx-build,
sphinx-build -b html docs/src/ docs/build/html
from the root directory.
License
Funding
Contributors to this project were funded by
Metadata
Release files for alc-aiidalab-widgets 0.3.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 |
|---|---|---|---|---|
| alc_aiidalab_widgets-0.3.1.tar.gz | 36.8 kB | Without provenance | Details for alc_aiidalab_widgets-0.3.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| alc_aiidalab_widgets-0.3.1-py3-none-any.whl | Python 3 | none | any | Details for alc_aiidalab_widgets-0.3.1-py3-none-any.whl |
Total release size: 82.6 kB
Release files / alc_aiidalab_widgets-0.3.1.tar.gz
| Download URL | alc_aiidalab_widgets-0.3.1.tar.gz |
|---|---|
| Size | 36.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
556232159263347a6845a43563b513967e84531b105f3f302fdc2b2555108cff
|
|
BLAKE2b-256 checksum How to use checksums |
c64b282ff63ed74b693dcdf826e4cd546ee96650e8663151e70a12e0ebf6fe7c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Release files / alc_aiidalab_widgets-0.3.1-py3-none-any.whl
| Download URL | alc_aiidalab_widgets-0.3.1-py3-none-any.whl |
|---|---|
| Size | 45.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ba5435cfb0cb302918a1571e86eea3a3ca36e9ca736ee1f4c50f8d39f065ee07
|
|
BLAKE2b-256 checksum How to use checksums |
5a03ee7fd1add2b94b4b52dfdd627db61f096c2d653bbaf51fdacf2a61855004
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.12.16
|
Security for alc-aiidalab-widgets 0.3.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.