project-report
Overview
Find software projects, analyze them, and output a report.
Getting Started
Install project-report
:
pip install project-report
A simple example:
import projectreport
# Do something with projectreport
See a more in-depth tutorial here.
Development Status
This project is currently in early-stage development. There may be breaking changes often. While the major version is 0, minor version upgrades will often have breaking changes.
Developing
First ensure that you have pipx
installed, if not, install it with pip install pipx
.
Then clone the repo and run npm install
and pipenv sync
. Run pipenv shell
to use the virtual environment. Make your changes and then run nox
to run formatting,
linting, and tests.
Develop documentation by running nox -s docs
to start up a dev server.
To run tests only, run nox -s test
. You can pass additional arguments to pytest
by adding them after --
, e.g. nox -s test -- -k test_something
.
Author
Created by Nick DeRobertis. MIT License.
Links
See the documentation here.
Author
Created by Nick DeRobertis. MIT License.