https://github.com/nickderobertis/project-report

A Python package for getting information about software projects
https://github.com/nickderobertis/project-report

Last synced: about 3 hours ago
JSON representation

A Python package for getting information about software projects

• Host: GitHub
• URL: https://github.com/nickderobertis/project-report
• Owner: nickderobertis
• License: mit
• Created: 2019-08-30T22:37:36.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-25T10:34:26.000Z (almost 2 years ago)
• Last Synced: 2024-12-25T05:04:43.505Z (about 1 month ago)
• Language: Python
• Size: 4.16 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


[![](https://codecov.io/gh/nickderobertis/project-report/branch/master/graph/badge.svg)](https://codecov.io/gh/nickderobertis/project-report)

[![PyPI](https://img.shields.io/pypi/v/project-report)](https://pypi.org/project/project-report/)

![PyPI - License](https://img.shields.io/pypi/l/project-report)

[![Documentation](https://img.shields.io/badge/documentation-pass-green)](https://nickderobertis.github.io/project-report/)

![Tests Run on Ubuntu Python Versions](https://img.shields.io/badge/Tests%20Ubuntu%2FPython-3.8%20%7C%203.9%20%7C%203.10-blue)

![Tests Run on Macos Python Versions](https://img.shields.io/badge/Tests%20Macos%2FPython-3.8%20%7C%203.9%20%7C%203.10-blue)

![Tests Run on Windows Python Versions](https://img.shields.io/badge/Tests%20Windows%2FPython-3.8%20%7C%203.9%20%7C%203.10-blue)

[![Github Repo](https://img.shields.io/badge/repo-github-informational)](https://github.com/nickderobertis/project-report/)

#  project-report

## Overview

Find software projects, analyze them, and output a report.

## Getting Started

Install `project-report`:

```

pip install project-report

```

A simple example:

```python

import projectreport

# Do something with projectreport

```

See a

[more in-depth tutorial here.](

https://nickderobertis.github.io/project-report/tutorial.html

)

## 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.](

https://nickderobertis.github.io/project-report/

)

## Author

Created by Nick DeRobertis. MIT License.