Metadata-Version: 2.4
Name: analytic-schema
Version: 1.0.2
Summary: I/O schema loader + validator for analytics notebooks
Author-email: Zachary Szewczyk <zacjszewczyk@gmail.com>
License: License
        =======
        
        The work in this folder is licensed by Zachary J. Szewczyk under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. See [http://creativecommons.org/licenses/by-nc-sa/4.0/](http://creativecommons.org/licenses/by-nc-sa/4.0/) for more information, or the text below for a full copy of the license.
        
        ### Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License
        
        By exercising the Licensed Rights (defined below), You accept and agree to be bound by the terms and conditions of this Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International Public License ("Public License"). To the extent this Public License may be interpreted as a contract, You are granted the Licensed Rights in consideration of Your acceptance of these terms and conditions, and the Licensor grants You such rights in consideration of benefits the Licensor receives from making the Licensed Material available under these terms and conditions.
        
        #### Section 1 - Definitions.
        
        a. **Adapted Material** means material subject to Copyright and Similar Rights that is derived from or based upon the Licensed Material and in which the Licensed Material is translated, altered, arranged, transformed, or otherwise modified in a manner requiring permission under the Copyright and Similar Rights held by the Licensor. For purposes of this Public License, where the Licensed Material is a musical work, performance, or sound recording, Adapted Material is always produced where the Licensed Material is synched in timed relation with a moving image.
        b. **Adapter's License** means the license You apply to Your Copyright and Similar Rights in Your contributions to Adapted Material in accordance with the terms and conditions of this Public License.
        c. **BY-NC-SA Compatible License** means a license listed at [creativecommons.org/compatiblelicenses](//creativecommons.org/compatiblelicenses), approved by Creative Commons as essentially the equivalent of this Public License.
        d. **Copyright and Similar Rights** means copyright and/or similar rights closely related to copyright including, without limitation, performance, broadcast, sound recording, and Sui Generis Database Rights, without regard to how the rights are labeled or categorized. For purposes of this Public License, the rights specified in Section 2(b)(1)-(2) are not Copyright and Similar Rights.
        e. **Effective Technological Measures** means those measures that, in the absence of proper authority, may not be circumvented under laws fulfilling obligations under Article 11 of the WIPO Copyright Treaty adopted on December 20, 1996, and/or similar international agreements.
        f. **Exceptions and Limitations** means fair use, fair dealing, and/or any other exception or limitation to Copyright and Similar Rights that applies to Your use of the Licensed Material.
        g. **License Elements** means the license attributes listed in the name of a Creative Commons Public License. The License Elements of this Public License are Attribution, NonCommercial, and ShareAlike.
        h. **Licensed Material** means the artistic or literary work, database, or other material to which the Licensor applied this Public License.
        i. **Licensed Rights** means the rights granted to You subject to the terms and conditions of this Public License, which are limited to all Copyright and Similar Rights that apply to Your use of the Licensed Material and that the Licensor has authority to license.
        j. **Licensor** means the individual(s) or entity(ies) granting rights under this Public License.
        k. **NonCommercial** means not primarily intended for or directed towards commercial advantage or monetary compensation. For purposes of this Public License, the exchange of the Licensed Material for other material subject to Copyright and Similar Rights by digital file-sharing or similar means is NonCommercial provided there is no payment of monetary compensation in connection with the exchange.
        l. **Share** means to provide material to the public by any means or process that requires permission under the Licensed Rights, such as reproduction, public display, public performance, distribution, dissemination, communication, or importation, and to make material available to the public including in ways that members of the public may access the material from a place and at a time individually chosen by them.
        m. **Sui Generis Database Rights** means rights other than copyright resulting from Directive 96/9/EC of the European Parliament and of the Council of 11 March 1996 on the legal protection of databases, as amended and/or succeeded, as well as other essentially equivalent rights anywhere in the world.
        n. **You** means the individual or entity exercising the Licensed Rights under this Public License. **Your** has a corresponding meaning.
        
        #### Section 2 - Scope.
        
        a. **License grant**.
            1. Subject to the terms and conditions of this Public License, the Licensor hereby grants You a worldwide, royalty-free, non-sublicensable, non-exclusive, irrevocable license to exercise the Licensed Rights in the Licensed Material to:
                A. reproduce and Share the Licensed Material, in whole or in part, for NonCommercial purposes only; and
                B. produce, reproduce, and Share Adapted Material for NonCommercial purposes only.
            2. Exceptions and Limitations. For the avoidance of doubt, where Exceptions and Limitations apply to Your use, this Public License does not apply, and You do not need to comply with its terms and conditions.
            3. Term. The term of this Public License is specified in Section 6(a).
            4. Media and formats; technical modifications allowed. The Licensor authorizes You to exercise the Licensed Rights in all media and formats whether now known or hereafter created, and to make technical modifications necessary to do so. The Licensor waives and/or agrees not to assert any right or authority to forbid You from making technical modifications necessary to exercise the Licensed Rights, including technical modifications necessary to circumvent Effective Technological Measures. For purposes of this Public License, simply making modifications authorized by this Section 2(a)(4) never produces Adapted Material.
            5. Downstream recipients.
                A. Offer from the Licensor - Licensed Material. Every recipient of the Licensed Material automatically receives an offer from the Licensor to exercise the Licensed Rights under the terms and conditions of this Public License.
                B. Additional offer from the Licensor - Adapted Material. Every recipient of Adapted Material from You automatically receives an offer from the Licensor to exercise the Licensed Rights in the Adapted Material under the conditions of the Adapter's License You apply.
                C. No downstream restrictions. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, the Licensed Material if doing so restricts exercise of the Licensed Rights by any recipient of the Licensed Material.
            6. No endorsement. Nothing in this Public License constitutes or may be construed as permission to assert or imply that You are, or that Your use of the Licensed Material is, connected with, or sponsored, endorsed, or granted official status by, the Licensor or others designated to receive attribution as provided in Section 3(a)(1)(A)(i).
        b. **Other rights**.
            1. Moral rights, such as the right of integrity, are not licensed under this Public License, nor are publicity, privacy, and/or other similar personality rights; however, to the extent possible, the Licensor waives and/or agrees not to assert any such rights held by the Licensor to the limited extent necessary to allow You to exercise the Licensed Rights, but not otherwise.
            2. Patent and trademark rights are not licensed under this Public License.
            3. To the extent possible, the Licensor waives any right to collect royalties from You for the exercise of the Licensed Rights, whether directly or through a collecting society under any voluntary or waivable statutory or compulsory licensing scheme. In all other cases the Licensor expressly reserves any right to collect such royalties, including when the Licensed Material is used other than for NonCommercial purposes.
        
        #### Section 3 - License Conditions.
        
        Your exercise of the Licensed Rights is expressly made subject to the following conditions.
        
        a. **Attribution**.
            1. If You Share the Licensed Material (including in modified form), You must:
                A. retain the following if it is supplied by the Licensor with the Licensed Material:
                    i. identification of the creator(s) of the Licensed Material and any others designated to receive attribution, in any reasonable manner requested by the Licensor (including by pseudonym if designated);
                    ii. a copyright notice;
                    iii. a notice that refers to this Public License;
                    iv. a notice that refers to the disclaimer of warranties;
                    v. a URI or hyperlink to the Licensed Material to the extent reasonably practicable;
                B. indicate if You modified the Licensed Material and retain an indication of any previous modifications; and
                C. indicate the Licensed Material is licensed under this Public License, and include the text of, or the URI or hyperlink to, this Public License.
            2. You may satisfy the conditions in Section 3(a)(1) in any reasonable manner based on the medium, means, and context in which You Share the Licensed Material. For example, it may be reasonable to satisfy the conditions by providing a URI or hyperlink to a resource that includes the required information.
            3. If requested by the Licensor, You must remove any of the information required by Section 3(a)(1)(A) to the extent reasonably practicable.
        
        b. **ShareAlike**.
        
        In addition to the conditions in Section 3(a), if You Share Adapted Material You produce, the following conditions also apply.
        
        1. The Adapter's License You apply must be a Creative Commons license with the same License Elements, this version or later, or a BY-NC-SA Compatible License.
        2. You must include the text of, or the URI or hyperlink to, the Adapter's License You apply. You may satisfy this condition in any reasonable manner based on the medium, means, and context in which You Share Adapted Material.
        3. You may not offer or impose any additional or different terms or conditions on, or apply any Effective Technological Measures to, Adapted Material that restrict exercise of the rights granted under the Adapter's License You apply.
        
        #### Section 4 - Sui Generis Database Rights.
        
        Where the Licensed Rights include Sui Generis Database Rights that apply to Your use of the Licensed Material:
        
        a. for the avoidance of doubt, Section 2(a)(1) grants You the right to extract, reuse, reproduce, and Share all or a substantial portion of the contents of the database for NonCommercial purposes only;
        b. if You include all or a substantial portion of the database contents in a database in which You have Sui Generis Database Rights, then the database in which You have Sui Generis Database Rights (but not its individual contents) is Adapted Material, including for purposes of Section 3(b); and
        c. You must comply with the conditions in Section 3(a) if You Share all or a substantial portion of the contents of the database.
        
        For the avoidance of doubt, this Section 4 supplements and does not replace Your obligations under this Public License where the Licensed Rights include other Copyright and Similar Rights.
        
        #### Section 5 - Disclaimer of Warranties and Limitation of Liability.
        
        a. **Unless otherwise separately undertaken by the Licensor, to the extent possible, the Licensor offers the Licensed Material as-is and as-available, and makes no representations or warranties of any kind concerning the Licensed Material, whether express, implied, statutory, or other. This includes, without limitation, warranties of title, merchantability, fitness for a particular purpose, non-infringement, absence of latent or other defects, accuracy, or the presence or absence of errors, whether or not known or discoverable. Where disclaimers of warranties are not allowed in full or in part, this disclaimer may not apply to You.**
        b. **To the extent possible, in no event will the Licensor be liable to You on any legal theory (including, without limitation, negligence) or otherwise for any direct, special, indirect, incidental, consequential, punitive, exemplary, or other losses, costs, expenses, or damages arising out of this Public License or use of the Licensed Material, even if the Licensor has been advised of the possibility of such losses, costs, expenses, or damages. Where a limitation of liability is not allowed in full or in part, this limitation may not apply to You.**
        c. The disclaimer of warranties and limitation of liability provided above shall be interpreted in a manner that, to the extent possible, most closely approximates an absolute disclaimer and waiver of all liability.
        
        #### Section 6 - Term and Termination.
        
        a. This Public License applies for the term of the Copyright and Similar Rights licensed here. However, if You fail to comply with this Public License, then Your rights under this Public License terminate automatically.
        b. Where Your right to use the Licensed Material has terminated under Section 6(a), it reinstates:
            1. automatically as of the date the violation is cured, provided it is cured within 30 days of Your discovery of the violation; or
            2. upon express reinstatement by the Licensor.For the avoidance of doubt, this Section 6(b) does not affect any right the Licensor may have to seek remedies for Your violations of this Public License.
        c. For the avoidance of doubt, the Licensor may also offer the Licensed Material under separate terms or conditions or stop distributing the Licensed Material at any time; however, doing so will not terminate this Public License.
        d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License.
        
        #### Section 7 - Other Terms and Conditions.
        
        a. The Licensor shall not be bound by any additional or different terms or conditions communicated by You unless expressly agreed.
        b. Any arrangements, understandings, or agreements regarding the Licensed Material not stated herein are separate from and independent of the terms and conditions of this Public License.
        
        #### Section 8 - Interpretation.
        
        a. For the avoidance of doubt, this Public License does not, and shall not be interpreted to, reduce, limit, restrict, or impose conditions on any use of the Licensed Material that could lawfully be made without permission under this Public License.
        b. To the extent possible, if any provision of this Public License is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If the provision cannot be reformed, it shall be severed from this Public License without affecting the enforceability of the remaining terms and conditions.
        c. No term or condition of this Public License will be waived and no failure to comply consented to unless expressly agreed to by the Licensor.
        d. Nothing in this Public License constitutes or may be interpreted as a limitation upon, or waiver of, any privileges and immunities that apply to the Licensor or You, including from the legal processes of any jurisdiction or authority.
Project-URL: Homepage, https://github.com/zacjszewczyk/analytic-schema
Project-URL: Issues, https://github.com/zacjszewczyk/analytic-schemaissues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: pandas>=1.0
Dynamic: license-file

# Analytic Schema

Analytic Schema is a lightweight Python package for loading, validating, and building standardized I/O documents for analytics notebooks based on a single, versioned JSON contract that drives both input parsing and output construction.

## Table of Contents

* [**Description**](#description)  
* [**Dependencies**](#dependencies)  
* [**Installation**](#installation)  
* [**Usage**](#usage)  
* [**Project structure**](#project-structure)  
* [**Background and Motivation**](#background-and-motivation)  
* [**Contributing**](#contributing)  
* [**Contributors**](#contributors)  
* [**License**](#license)  

## Description

Analytic Schema centralizes your notebook or script I/O definitions into one authoritative JSON file. From that contract it automatically:

- Generates a complete command-line interface (via `argparse`) for every input field.  
- Parses parameters provided as CLI flags, JSON dictionaries, or JSON files.  
- Injects sensible defaults for all optional inputs.  
- Performs deep schema validation (type checks, enums, date-time formats, oneOf branches, and no extra fields).  
- Builds structured output documents with embedded metadata, SHA-256 hashes for auditability, and a built-in logging mechanism.  

With zero dependencies beyond the standard library and `pandas`, Analytic Schema is ideal for air-gapped notebooks, CI pipelines, or any environment where you need a robust, self-contained I/O layer for cybersecurity analytics.

## Dependencies

This project depends only on the Python standard library (>=3.8) and `pandas` (>=1.0).

## Installation

```
pip install analytic-schema
```

In your code:

```
import analytic_schema
```

## Usage

Below is a minimal end-to-end example showing how to go from raw inputs to a validated output file:

```
from analytic_schema import parse_input, validate_input, OutputDoc
import time
 # 1) Parse input parameters (CLI string, list, JSON, or file)
raw = parse_input(
    “—input-schema-version 1.0.0 “
    “—start-dtg 2025-06-01T00:00:00Z “
    “—end-dtg   2025-06-02T00:00:00Z “
    “—data-source-type file “
    “—data-source /tmp/log.csv”
)
 # 2) Validate against the JSON contract and fill defaults
params = validate_input(raw)
 # 3) Run your analytic logic…
start = time.perf_counter()

# ... your detection code here ...

findings = [
    {
        “finding_id”: “uuid-v4”,
        “title”: “Suspicious pattern”,
        “description”: “Detected anomalous traffic...”,
        “event_dtg”: “2025-06-07T12:34:56Z”,
        “severity”: “high”,
        “confidence”: “0.92”,
        “observables”: [“1.2.3.4”, “bad.example.com”],
        “mitre_attack_tactics”: [“TA0001”],
        “mitre_attack_techniques”: [“T1001”],
        “recommended_actions”: “Block IP and review logs”,
        “recommended_pivots”: “Check DNS logs”,
        “classification”: “U”
    }
]
elapsed_ms = (time.perf_counter() - start) * 1000
 # 4) Build the structured output document
out = OutputDoc(
    input_data_hash=params[“input_data_hash”],
    inputs=params,
    findings=findings,
    records_processed=len(findings)
)
out.add_message(“INFO”, “Analysis completed in %.2f ms” % elapsed_ms)
out.finalise()
 # 5) Serialize to JSON
out.save(“analysis_output.json”)
```

This example demonstrates how Analytic Schema handles all the I/O boilerplate—CLI parsing, default injection, validation, metadata, logging, hashing, and final serialization—so you can focus on the core analytic logic.

## Project structure

```
analytic-schema/ # Project repository
├── analytic_schema/ # Package
│   ├── __init__.py
│   ├── loader.py
│   ├── parser.py
│   ├── validator.py
│   ├── output.py
│   └── analytic_schema.json
│
├── tests/
│   └── test_analytic_schema.py
│
├── example_usage.py
│
├── README.md      # This file
├── LICENSE.md     # Project license
├── Makefile       # Project makefile
└── pyproject.toml
```

## Background and Motivation

In cybersecurity analytics, consistency and auditability are paramount. Analysts and automation pipelines often spin up dozens of scripts and notebooks, each rolling its own argument parsing, validation, and output formatting. This fragmentation leads to subtle bugs, schema drift, and integration headaches.

Analytic Schema addresses these challenges by elevating your I/O contract to one single JSON schema. This contract drives:

- **Uniformity**: All analytics share the same field names, types, and defaults.  
- **Reliability**: Fail-fast validation prevents runtime surprises from missing or mistyped parameters.  
- **Traceability**: Inputs and findings are hashed, and logs are captured inline, enabling full audit trails.  
- **Simplicity**: With only the standard library plus `pandas`, it works in air-gapped environments and keeps your dependencies minimal.  

By abstracting away boilerplate, you can focus on detecting and investigating threats, while ensuring your pipelines remain robust, maintainable, and easily integrated.

## Contributing

Contributions are welcome from all, regardless of rank or position.

There are no system requirements for contributing to this project. To contribute via the web:

1. Click GitLab’s “Web IDE” button to open the online editor.
2. Make your changes. **Note:** limit your changes to one part of one file per commit; for example, edit only the “Description” section here in the first commit, then the “Background and Motivation” section in a separate commit.
3. Once finished, click the blue “Commit...” button.
4. Write a detailed description of the changes you made in the “Commit Message” box.
5. Select the “Create a new branch” radio button if you do not already have your own branch; otherwise, select your branch. The recommended naming convention for new branches is `first.middle.last`.
6. Click the green “Commit” button.

You may also contribute to this project using your local machine by cloning this repository to your workstation, creating a new branch, committing and pushing your changes, and creating a merge request.

## Contributors

This section lists project contributors. When you submit a merge request, remember to append your name to the bottom of the list below. You may also include a brief list of the sections to which you contributed.

* **Creator:** Zachary Szewczyk

## License

This project is licensed under the [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-nc-sa/4.0/). You can view the full text of the license in [LICENSE.md](./LICENSE.md). Read more about the license [at the original author’s website](https://zacs.site/disclaimers.html). Generally speaking, this license allows individuals to remix this work provided they release their adaptation under the same license and cite this project as the original, and prevents anyone from turning this work or its derivatives into a commercial product.
