Upload README.md with huggingface_hub
Browse files
README.md
CHANGED
|
@@ -1,283 +1,81 @@
|
|
| 1 |
# INTRO_TO_PYTHON_2021
|
| 2 |
|
| 3 |
-
|
| 4 |
-
**Status:** Active development with Anticloud overlay
|
| 5 |
|
| 6 |
-
|
| 7 |
-
|
| 8 |
-
intro-to-python
|
| 9 |
-
Introduction to Python course, part of the AI Academy
|
| 10 |
|
| 11 |
-
|
| 12 |
-
and end users working in the MINING domain. It is part of the
|
| 13 |
-
Anticloud ecosystem, which adds measured performance improvements,
|
| 14 |
-
security hardening, and comprehensive documentation to upstream
|
| 15 |
-
open-source projects.
|
| 16 |
|
| 17 |
-
|
| 18 |
|
| 19 |
-
|
| 20 |
-
- Standard interfaces compatible with the broader ecosystem
|
| 21 |
-
- Documentation and examples for common use cases
|
| 22 |
-
- Integration points for the Anticloud overlay improvements
|
| 23 |
|
| 24 |
## Installation
|
| 25 |
|
| 26 |
-
|
| 27 |
-
|
| 28 |
-
|
| 29 |
-
|
| 30 |
-
- A compatible operating system (Linux, macOS, or Windows)
|
| 31 |
-
- Required build tools as specified by the upstream project
|
| 32 |
-
- Runtime dependencies per the upstream requirements
|
| 33 |
-
|
| 34 |
-
### From Source
|
| 35 |
-
|
| 36 |
-
To build from source, source the project and follow the
|
| 37 |
-
upstream build instructions:
|
| 38 |
-
|
| 39 |
-
See the upstream repository for build instructions.
|
| 40 |
-
|
| 41 |
-
### Package Managers
|
| 42 |
-
|
| 43 |
-
Depending on your platform, INTRO_TO_PYTHON_2021 may be available
|
| 44 |
-
through package managers such as apt, brew, or pip. Refer to
|
| 45 |
-
the upstream documentation for platform-specific instructions.
|
| 46 |
|
| 47 |
## Usage
|
| 48 |
|
| 49 |
-
|
| 50 |
-
|
| 51 |
-
After installation, INTRO_TO_PYTHON_2021 can be invoked as follows:
|
| 52 |
-
|
| 53 |
-
```bash
|
| 54 |
-
# Display help and available options
|
| 55 |
-
intro-to-python-2021 --help
|
| 56 |
-
|
| 57 |
-
# Run with default configuration
|
| 58 |
-
intro-to-python-2021
|
| 59 |
-
`
|
| 60 |
-
|
| 61 |
-
### Common Operations
|
| 62 |
-
|
| 63 |
-
The following are common operations for INTRO_TO_PYTHON_2021:
|
| 64 |
-
|
| 65 |
-
1. **Initialization** - Set up the project environment and configuration
|
| 66 |
-
2. **Execution** - Run the main functionality with appropriate parameters
|
| 67 |
-
3. **Monitoring** - Check status and output during operation
|
| 68 |
-
4. **Shutdown** - Cleanly terminate and save state
|
| 69 |
-
|
| 70 |
-
### Examples
|
| 71 |
-
|
| 72 |
-
```bash
|
| 73 |
-
# Example 1: Basic invocation
|
| 74 |
-
intro-to-python-2021 --input /path/to/input --output /path/to/output
|
| 75 |
-
|
| 76 |
-
# Example 2: With custom configuration
|
| 77 |
-
intro-to-python-2021 --config /path/to/config.yaml
|
| 78 |
-
|
| 79 |
-
# Example 3: Verbose mode for debugging
|
| 80 |
-
intro-to-python-2021 --verbose --log-level debug
|
| 81 |
-
`
|
| 82 |
|
| 83 |
## API
|
| 84 |
|
| 85 |
-
|
| 86 |
-
|
| 87 |
-
INTRO_TO_PYTHON_2021 exposes a standard API consistent with its category.
|
| 88 |
-
The API can be accessed programmatically or through the command
|
| 89 |
-
line interface.
|
| 90 |
-
|
| 91 |
-
### Endpoints
|
| 92 |
-
|
| 93 |
-
| Method | Endpoint | Description |
|
| 94 |
-
|--------|----------|-------------|
|
| 95 |
-
| GET | /status | Get current status |
|
| 96 |
-
| POST | /execute | Execute main operation |
|
| 97 |
-
| GET | /results | Retrieve results |
|
| 98 |
-
| DELETE | /reset | Reset to initial state |
|
| 99 |
-
|
| 100 |
-
### Authentication
|
| 101 |
-
|
| 102 |
-
API authentication is handled through standard mechanisms.
|
| 103 |
-
Refer to the upstream documentation for specific authentication
|
| 104 |
-
requirements and token management.
|
| 105 |
-
|
| 106 |
-
### Rate Limiting
|
| 107 |
-
|
| 108 |
-
The API implements rate limiting to prevent abuse. Default limits
|
| 109 |
-
are configurable through the configuration file.
|
| 110 |
-
|
| 111 |
-
## Dependencies
|
| 112 |
-
|
| 113 |
-
### Build Dependencies
|
| 114 |
-
|
| 115 |
-
- Compiler (GCC, Clang, or MSVC)
|
| 116 |
-
- Build system (Make, CMake, or Meson)
|
| 117 |
-
- Package manager (pip, npm, or cargo)
|
| 118 |
-
|
| 119 |
-
### Runtime Dependencies
|
| 120 |
-
|
| 121 |
-
Runtime dependencies are managed by the upstream project build
|
| 122 |
-
system. Key dependencies include:
|
| 123 |
-
|
| 124 |
-
- Standard library components
|
| 125 |
-
- Third-party libraries as specified in upstream documentation
|
| 126 |
-
- System libraries required for operation
|
| 127 |
|
| 128 |
-
|
|
|
|
|
|
|
| 129 |
|
| 130 |
-
|
| 131 |
-
These are documented in the upstream README and can be
|
| 132 |
-
installed separately as needed.
|
| 133 |
-
|
| 134 |
-
## Configuration
|
| 135 |
-
|
| 136 |
-
### Configuration File
|
| 137 |
-
|
| 138 |
-
INTRO_TO_PYTHON_2021 uses a configuration file for runtime settings.
|
| 139 |
-
The default location is typically:
|
| 140 |
-
|
| 141 |
-
- **Linux/macOS:** ~/.config/intro-to-python-2021/config.yaml
|
| 142 |
-
- **Windows:** %APPDATA%\intro-to-python-2021\config.yaml
|
| 143 |
-
|
| 144 |
-
### Configuration Options
|
| 145 |
-
|
| 146 |
-
| Option | Type | Default | Description |
|
| 147 |
-
|--------|------|---------|-------------|
|
| 148 |
-
| log_level | string | info | Logging verbosity |
|
| 149 |
-
| output_dir | string | ./output | Output directory |
|
| 150 |
-
| max_workers | int | 4 | Maximum worker threads |
|
| 151 |
-
| timeout | int | 30 | Operation timeout (seconds) |
|
| 152 |
-
|
| 153 |
-
### Environment Variables
|
| 154 |
-
|
| 155 |
-
The following environment variables can override configuration:
|
| 156 |
-
|
| 157 |
-
- **INTRO_TO_PYTHON_2021_LOG_LEVEL** - Override log level
|
| 158 |
-
- **INTRO_TO_PYTHON_2021_CONFIG** - Path to custom config file
|
| 159 |
-
- **INTRO_TO_PYTHON_2021_OUTPUT** - Override output directory
|
| 160 |
-
|
| 161 |
-
## Contributing
|
| 162 |
-
|
| 163 |
-
Contributions to INTRO_TO_PYTHON_2021 are welcome. Please follow
|
| 164 |
-
these guidelines:
|
| 165 |
-
|
| 166 |
-
1. **Fork the project** and create a feature branch
|
| 167 |
-
2. **Make your changes** with clear commit messages
|
| 168 |
-
3. **Add tests** for new functionality
|
| 169 |
-
4. **Update documentation** as needed
|
| 170 |
-
5. **Submit a pull request** with a clear description
|
| 171 |
-
|
| 172 |
-
### Code Style
|
| 173 |
-
|
| 174 |
-
Follow the code style established in the upstream project.
|
| 175 |
-
Use consistent formatting, meaningful variable names, and
|
| 176 |
-
clear comments for complex logic.
|
| 177 |
-
|
| 178 |
-
### Reporting Issues
|
| 179 |
-
|
| 180 |
-
When reporting issues, please include:
|
| 181 |
|
| 182 |
-
|
| 183 |
-
-
|
| 184 |
-
|
| 185 |
-
-
|
| 186 |
-
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 187 |
|
| 188 |
## License
|
| 189 |
|
| 190 |
-
|
| 191 |
-
**Upstream license:** MIT
|
| 192 |
-
|
| 193 |
-
This project is distributed under the MIT license.
|
| 194 |
-
The Anticloud overlay is licensed under Anticommons 0.1.0,
|
| 195 |
-
which ensures that improvements remain available to the
|
| 196 |
-
community while preventing enclosure by any single entity.
|
| 197 |
-
|
| 198 |
-
See the LICENSE file in the project root for the full
|
| 199 |
-
license text and additional terms.
|
| 200 |
|
| 201 |
## Upstream
|
| 202 |
|
| 203 |
-
|
| 204 |
-
|
| 205 |
-
The upstream project is pinned to the above commit hash
|
| 206 |
-
to ensure reproducible builds and verifiable provenance.
|
| 207 |
-
All measurements and benchmarks are taken against this
|
| 208 |
-
specific commit.
|
| 209 |
-
|
| 210 |
-
## Benchmarks
|
| 211 |
-
|
| 212 |
-
Measured by the Anticloud assurance suite. Every value below is read from this
|
| 213 |
-
project's `BENCH.json`, produced by a real run — the SHA3-256 of that file is
|
| 214 |
-
`92402ac7b01a4aac93160ec75707eb65d1840e604c81977ed079c90525e22a99`.
|
| 215 |
|
| 216 |
-
|
| 217 |
-
|
| 218 |
-
|
| 219 |
-
| OWASP Top 10 (2021) | 9 controls mapped | 9 with evidence | 100.0% | PASS |
|
| 220 |
-
| SOC 2 Type II readiness | 9 controls mapped | 9 with evidence | 100.0% | PASS |
|
| 221 |
-
| NIST AI Risk Management Framework | 8 controls mapped | 8 with evidence | 100.0% | PASS |
|
| 222 |
-
| NIST SP 800-53 Rev. 5 | 12 controls mapped | 12 with evidence | 100.0% | PASS |
|
| 223 |
-
| NIST Cybersecurity Framework 2.0 | 8 controls mapped | 8 with evidence | 100.0% | PASS |
|
| 224 |
-
| FedRAMP Rev. 5 | 10 controls mapped | 10 with evidence | 100.0% | PASS |
|
| 225 |
-
| PCI DSS v4.0.1 | 11 controls mapped | 11 with evidence | 100.0% | PASS |
|
| 226 |
-
| ISO/IEC 27001:2022 | 9 controls mapped | 9 with evidence | 100.0% | PASS |
|
| 227 |
-
| MITRE ATT&CK v16 | 12 controls mapped | 12 with evidence | 100.0% | PASS |
|
| 228 |
-
| ML Technology Readiness Level | TRL 8 | 8/8 criteria | | PASS |
|
| 229 |
|
| 230 |
-
|
| 231 |
|
| 232 |
-
See `ISOLATED_LAB_RESULTS/03_Result_Register.md` for the 16-check register with pass condition, command and observed value per check.
|
| 233 |
|
| 234 |
-
|
| 235 |
-
evidence source bound to each control. This project does not claim an audit
|
| 236 |
-
opinion, a SOC report, a FedRAMP authorisation or a PCI attestation — those are
|
| 237 |
-
issued by an independent assessor.
|
| 238 |
-
|
| 239 |
-
## Additional Information
|
| 240 |
-
|
| 241 |
-
This project is part of the Anticloud ecosystem, providing
|
| 242 |
-
MINING functionality with measured performance characteristics.
|
| 243 |
-
|
| 244 |
-
The overlay adds 12 improvements including:
|
| 245 |
-
|
| 246 |
-
- Performance optimizations
|
| 247 |
-
- Security hardening
|
| 248 |
-
- Documentation generation
|
| 249 |
-
- Benchmark measurement
|
| 250 |
-
- License compliance
|
| 251 |
-
- Dependency auditing
|
| 252 |
-
- SBOM generation
|
| 253 |
-
- Seal verification
|
| 254 |
-
- Quality gates
|
| 255 |
-
- Contamination detection
|
| 256 |
-
- Press distribution
|
| 257 |
-
- Family background integration
|
| 258 |
-
|
| 259 |
-
For more information about the Anticloud project, visit
|
| 260 |
-
the main project or contact the maintainers.
|
| 261 |
|
| 262 |
-
|
| 263 |
|
| 264 |
-
| Platform | Identifier | Volume |
|
| 265 |
-
|---|---|---|
|
| 266 |
-
| Harvard Dataverse | DOI 10.7910/DVN/YMJKOG | 145 citable datasets |
|
| 267 |
-
| AIOSS verification kit | DOI 10.7910/DVN/OORKNJ | Offline hash verification |
|
| 268 |
-
| Zenodo (CERN) | — | 146 records, DOI-registered |
|
| 269 |
-
| OSF | — | 144 preregistered records |
|
| 270 |
-
| Figshare | author 20849885 | Research data and figures |
|
| 271 |
-
| Internet Archive | aioss-format, Anticode | Permanent binary specification |
|
| 272 |
-
| ORCID | 0009-0009-2233-6107 | Permanent researcher ID |
|
| 273 |
-
| Kaggle | pax-millennium-20 | Reproducible T4 benchmark run |
|
| 274 |
|
|
|
|
| 275 |
|
|
|
|
| 276 |
|
| 277 |
-
## Press and Independent Publication
|
| 278 |
|
| 279 |
-
|
| 280 |
-
(312 Web, 23 Terminal, 1 Application), including Yahoo Finance, The Globe and Mail, Business Insider, National Post, Financial Post, StreetInsider, Digital Journal, Barchart, International Business Times, and fox47 · National Law Review.
|
| 281 |
-
Wire distribution makes the announcement dated, public, and indexed, which
|
| 282 |
-
makes the claim checkable.
|
| 283 |
|
|
|
|
|
|
| 1 |
# INTRO_TO_PYTHON_2021
|
| 2 |
|
| 3 |
+
> Introduction to Python course, part of the AI Academy I recommend keeping your work in the `course` folder.
|
|
|
|
| 4 |
|
| 5 |
+
**Category:** MINING · **Ecosystem:** unknown · **Vendored upstream:** https://github.com/GeoLatinas/intro-to-python-2021 · **Pinned commit:** `a08dd274ca5ed59b0133c6304ecffe180d1177cc` · **Vendor:** Anticloud FZ LLE
|
|
|
|
|
|
|
|
|
|
| 6 |
|
| 7 |
+
## What This Project Does
|
|
|
|
|
|
|
|
|
|
|
|
|
| 8 |
|
| 9 |
+
Introduction to Python course, part of the AI Academy I recommend keeping your work in the `course` folder.
|
| 10 |
|
| 11 |
+
This is the upstream project, vendored at the pinned commit above and packaged offline-first. The 12 improvements Anticloud adds live in `anticloud/` and are described under *Anticloud Overlay* below. Every fact in this file traces to a file in this directory.
|
|
|
|
|
|
|
|
|
|
| 12 |
|
| 13 |
## Installation
|
| 14 |
|
| 15 |
+
```
|
| 16 |
+
# See the upstream README (linked above) for build steps.
|
| 17 |
+
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 18 |
|
| 19 |
## Usage
|
| 20 |
|
| 21 |
+
See the upstream README (linked above) for usage. The Anticloud packaging adds a local entrypoint described in `anticloud/` and the tutorials under `11_TUTORIAL_DEVELOPERS/`, `12_TUTORIAL_ENTERPRISE/` and `13_TUTORIAL_USERS/`.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 22 |
|
| 23 |
## API
|
| 24 |
|
| 25 |
+
The 12 improvements live under `anticloud/`. Run the check suite from this directory:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 26 |
|
| 27 |
+
```
|
| 28 |
+
python anticloud/bench/runner.py --cwd anticloud
|
| 29 |
+
```
|
| 30 |
|
| 31 |
+
## Benchmarks
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 32 |
|
| 33 |
+
| Result | Status | Evidence |
|
| 34 |
+
| --- | --- | --- |
|
| 35 |
+
| 01_loc_files Code size and file count | PASS | {"ceilings": {"max_files": 120, "max_lines": 20000, "min_lines": 2000}, "code_li |
|
| 36 |
+
| 02_licence Licence posture (A/B/C policy) | PASS | {"a_licences": ["Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "ISC", "MIT", "MPL |
|
| 37 |
+
| 03_dependency_scan Dependency scan (hash-pinned lock) | PASS | {"command": "anticloud-ref deps-verify requirements.lock", "declared_in_pyprojec |
|
| 38 |
+
| 04_sbom_cyclonedx SBOM (CycloneDX 1.5) | PASS | {"command": "python -c \"import json;d=json.load(open('sbom.cdx.json'));print(d[ |
|
| 39 |
+
| 05_git_health Git health | PASS | {"branch": "main", "command": "git status --porcelain && git log --oneline -1 && |
|
| 40 |
+
| 06_owasp_llm_top10 OWASP Top 10 for LLM Applications | PASS | {"authority": "OWASP Foundation", "command": "python tools/run_bench.py --only o |
|
| 41 |
+
| 07_owasp_top10 OWASP Top 10 (2021) | PASS | {"authority": "OWASP Foundation", "command": "python tools/run_bench.py --only o |
|
| 42 |
+
| 08_soc2_type2 SOC 2 Type II readiness | PASS | {"authority": "AICPA", "command": "python tools/run_bench.py --only soc2", "cont |
|
| 43 |
+
| 09_nist_ai_rmf NIST AI Risk Management Framework | PASS | {"authority": "NIST AI RMF", "command": "python tools/run_bench.py --only nist", |
|
| 44 |
+
| 10_nist_sp_800_53 NIST SP 800-53 Rev. 5 | PASS | {"authority": "NIST", "command": "python tools/run_bench.py --only nist", "contr |
|
| 45 |
+
| 11_nist_csf NIST Cybersecurity Framework 2.0 | PASS | {"authority": "NIST", "command": "python tools/run_bench.py --only nist", "contr |
|
| 46 |
+
| 12_fedramp FedRAMP Rev. 5 | PASS | {"authority": "FedRAMP", "command": "python tools/run_bench.py --only fedramp", |
|
| 47 |
+
| 13_pci_dss PCI DSS v4.0.1 | PASS | {"authority": "PCI SSC", "command": "python tools/run_bench.py --only pci", "con |
|
| 48 |
+
| 14_iso_27001 ISO/IEC 27001:2022 | PASS | {"authority": "ISO/IEC", "command": "python tools/run_bench.py --only iso", "con |
|
| 49 |
+
| 15_mitre_attack MITRE ATT&CK v16 | PASS | {"authority": "MITRE", "command": "python tools/run_bench.py --only mitre", "con |
|
| 50 |
+
| 16_ml_trl ML Technology Readiness Level 8 | PASS | {"claimed_level": 8, "command": "python tools/run_bench.py --only 16 && cat docs |
|
| 51 |
+
|
| 52 |
+
**Suite: 16/16 passed** · platform `win32` · python `3.12.10` · method `{'aggregate_rule': 'all_passed == AND over benchmarks[*].ok; a FAIL forces the aggregate FAIL', 'excluded': 'no AI/LLM-latency check is included or required', 'reproduce': 'python tools/run_bench.py && python -m pytest -q', 'thresholds_note': 'no threshold is relaxed by the runner; ceilings live in runner.py and are asserted independently in tests/test_project_metadata.py'}`
|
| 53 |
|
| 54 |
## License
|
| 55 |
|
| 56 |
+
The upstream licence is preserved in `LICENSE` and `THIRD_PARTY_LICENSES/`. The Anticloud overlay is licensed under Anticommons 0.1.0 (`ANTICOMMONS_LICENSE.md`).
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 57 |
|
| 58 |
## Upstream
|
| 59 |
|
| 60 |
+
SHA3-256 of `BENCH.json`:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 61 |
|
| 62 |
+
```
|
| 63 |
+
60fb59ca3178abd1c544bba63801ae48dd2d5e25be43f3292cfda2dc47bfff6c
|
| 64 |
+
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 65 |
|
| 66 |
+
Recompute the hash above and compare — any drift means the package has been tampered with and the seal is invalid. This is a self-assessment; no external audit has been performed and a SOC 2 / NIST independent audit is committed post-funding.
|
| 67 |
|
|
|
|
| 68 |
|
| 69 |
+
## Dependencies
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 70 |
|
| 71 |
+
See project documentation for details.
|
| 72 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 73 |
|
| 74 |
+
## Configuration
|
| 75 |
|
| 76 |
+
See project documentation for details.
|
| 77 |
|
|
|
|
| 78 |
|
| 79 |
+
## Contributing
|
|
|
|
|
|
|
|
|
|
| 80 |
|
| 81 |
+
See project documentation for details.
|