mitre / emass_client

The eMASS client repository maintains the Enterprise Mission Assurance Support Service (eMASS) Representational State Transfer (REST) Application Programming Interface (API) specification and executables.
https://mitre.github.io/emass_client/
12 stars 2 forks source link

Non-Python code exists where it shouldn't #19

Open cyberphor opened 1 month ago

cyberphor commented 1 month ago

Discussion

Several .py files include the text below even though it's not Python code. I assume it's added automatically by the OpenAPI generator, but I could be wrong.

## eMASS API v3.12 Specification

The emass_client_api is a Python client that implements the [Enterprise Mission Assurance Support Service (eMASS)](https://disa.mil/~/media/Files/DISA/Fact-Sheets/eMASS.pdf)
Representational State Transfer (REST) Application Programming Interface (API) specifications.

This Python package was generated from the eMASS API specification:

- API version: v3.12
- Package version: 3.12.0
- Build date: 2023-10-10T14:36:02.975730Z[Etc/UTC]

## Requirements.

Python 3.7+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:

import emass_client

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

python setup.py install --user

(or `sudo python setup.py install` to install the package for all users)

Then import the package:

import emass_client

### Tests

Execute `pytest` to run the tests.

Recommendation

Remove or comment-out the lines mentioned above.

cyberphor commented 1 month ago

Submitted a pull request (#20) to address this issue.