Metadata-Version: 2.1
Name: nprintml
Version: 0.0.1
Summary: Fully automated traffic analysis with nPrint
Home-page: https://github.com/nprint/nprintml
License: License :: OSI Approved :: Apache Software License
Description: # nprintML
        
        nprintML bridges the gap between [nPrint](https://nprint.github.io/nprint/), which generates standard fingerprints for packets, and AutoML, which allows for optimized model training and traffic analysis. nprintML enables users with network traffic and labels to perform optimized packet-level traffic analysis **without writing any code**.
        
        
        ## Getting It
        
        ### Dependencies
        
        Python versions 3.6 through 3.8 are supported.
        
        You might check what versions of Python are installed on your system, _e.g._:
        
            ls -1 /usr/bin/python*
        
        As needed, consult your package manager or [python.org](https://python.org/).
        
        Depending on your situation, consider [pyenv](https://github.com/pyenv/pyenv) for easy installation and management of arbitrary versions of Python.
        
        nprintML further requires nPrint (see below).
        
        ### Installation
        
        nprintML itself is available for download from the [Python Package Index (PyPI)](https://pypi.org/) and via `pip`:
        
            python -m pip install nprintml
        
        This downloads, builds and installs the `nprintml` console command. If you're happy to manage your Python (virtual) environment, you're all set with the above.
        
        That said, installation of this command via a tool such as [pipx](https://pipxproject.github.io/pipx/) is strongly encouraged. pipx will ensure that nprintML is installed into its own virtual environment, such that its third-party libraries do not conflict with any others installed on your system.
        
        (Note that nPrint and nprintML are unrelated to the PyPI distribution named "nprint.")
        
        ### Post-installation
        
        nprintML depends on the nPrint command, which may be installed separately, (with reference to the [nPrint documentation](https://github.com/nprint/nprint/wiki/2.-Installation)).
        
        For quick-and-easy satisfaction of this requirement, nprintML supplies the bootstrapping command `nprint-install`, which is made available to your environment with nprintML installed. This command will inspect its execution environment and attempt to retrieve, compile and install nPrint with the most appropriate defaults:
        
            nprint-install
        
        nPrint may thereby be installed system-globally, to the user environment, to the (virtual) environment to which nprintML was installed, or to a specified path prefix. Consult the command's `--help` for more information.
        
        `nprint-install` is identically available through its Python module (no different from `pip` above):
        
            python -m nprintml.net.install
        
        
        ## Using It
        
        nprintML supplies the top-level shell command `nprintml` &ndash;
        
            nprintml ...
        
        &ndash; as well as its terse alias `nml` &ndash;
        
            nml ...
        
        In case of command path ambiguity and in support of debugging, the `nprintml` command is also available through its Python module:
        
            python -m nprintml ...
        
        ---
        
        THIS IS HOW YOU USE IT!
        
        
        ## Development
        
        Development requirements may be installed via the `dev` extra (below assuming a source checkout):
        
            pip install --editable .[dev]
        
        (Note: the installation flag `--editable` is also used above to instruct `pip` to place the source checkout directory itself onto the Python path, to ensure that any changes to the source are reflected in Python imports.)
        
        Development tasks are then managed via [argcmdr](https://github.com/dssg/argcmdr) sub-commands of `manage …`, (as defined by the repository module `manage.py`), _e.g._:
        
            manage version patch -m "initial release of nprintml" \
                   --build                                        \
                   --release
        
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: System :: Networking :: Monitoring
Classifier: Topic :: Security
Classifier: Topic :: Terminals
Requires-Python: >=3.6,<4
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
