Skip to main content

Courses often use a restricted subset of a programming language and its library, to reduce cognitive load, focus on concepts, simplify marking, etc.

allowed is a program that checks if your code files and Jupyter notebooks only use the Python constructs that were taught.

allowed enables instructors to check in advance their examples, exercises and assessment for inadvertent use of constructs that weren't taught. It also allows students and instructors to check submitted code against the taught constructs. To do its job, allowed requires a short file that lists which constructs were introduced in which 'unit' of the course. That file can be used as a reference document to onboard new tutors and to discuss the design of the course, e.g. to check if important constructs are missing or if some units are overloaded.

Like all static analysis tools, allowed isn't perfect and will never be. There may be false positives (code reported to be a violation, but isn't) and false negatives (code that uses disallowed constructs but isn't reported).

To refer to allowed in a publication, please cite

Michel Wermelinger. Checking Conformance to a Subset of the Python Language. Proceedings of the Conference on Innovation and Technology in Computer Science Education (ITiCSE), vol. 2, pp. 573–574. ACM, 2023.

Instructions

If you're an M269 student or tutor, follow the M269 software installation instructions, and use the M269 technical forum or the tutor forum to report issues and ask questions.

Otherwise, follow the instructions on how to install, use and configure allowed. If you need help, post your query in the Q & A discussion forum.

Contributing

Any help to improve allowed is welcome and appreciated.

  • If you use allowed, please share your experience and tips in the show & tell forum.
  • If you require a new feature, please suggest it in the ideas discussion forum.
  • If you spot an error in the code or documentation, please check if it has been reported, before creating a new issue.
  • If you want to contribute code or documentation that addresses an open issue, please read first our code contribution guide. Your contribution will become available under the terms below.

Licences

The code and text in this repository are Copyright © 2023 by The Open University, UK. The code is licensed under a BSD 3-clause licence. The text is licensed under a Creative Commons Attribution 4.0 International Licence.

Metadata

Release files for allowed 1.5.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for allowed 1.5.5
File Size Uploaded Provenance Actions
allowed-1.5.5.tar.gz 15.2 kB Without provenance Details for allowed-1.5.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for allowed 1.5.5
File Interpreter ABI Platform Actions
allowed-1.5.5-py3-none-any.whl Python 3 none any Details for allowed-1.5.5-py3-none-any.whl

Total release size: 32.3 kB

Release files / allowed-1.5.5.tar.gz

Download URL allowed-1.5.5.tar.gz
Size 15.2 kB
Tags Source
SHA-256 checksum
How to use checksums
32d795fa9c7a8b1764d3b0b4ea2ec32f2e24e15be36becb98579f6e9394d187f
BLAKE2b-256 checksum
How to use checksums
d19558e2793dba69c3e73ed469852e85e9c70580df17592906ecf32530c84e57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.12.10 Darwin/24.6.0

Release files / allowed-1.5.5-py3-none-any.whl

Download URL allowed-1.5.5-py3-none-any.whl
Size 17.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8d1dcfe7eb271713a9b14bad6bc8483c5581c7259a66d9cf03b9b2d4c9bd09b5
BLAKE2b-256 checksum
How to use checksums
7ac5851bfd6f558604fc8b93bd911933e22733a733a112273366de1eadbb4353
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.1.3 CPython/3.12.10 Darwin/24.6.0

Security for allowed 1.5.5

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page