Metadata-Version: 2.1
Name: pycodestats
Version: 0.1.0
Summary: A tool to count lines of code in a Python project
Home-page: https://github.com/sammrai/pycodestats
Author: sammrai
Author-email: saku0aab@gmail.com
License: MIT
Project-URL: Homepage, https://github.com/sammrai/pycodestats
Project-URL: Documentation, https://github.com/sammrai/pycodestats
Project-URL: Source, https://github.com/sammrai/pycodestats
Project-URL: Tracker, https://github.com/sammrai/pycodestats/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jsonschema>=3.2

# pycodestats

pycodestats is a tool to count lines of code, classes, and methods in a Python project. It can scan directories recursively and provides summary statistics for each file or directory.

## Features

- Counts lines of code (excluding comments and docstrings)
- Counts number of classes and methods
- Outputs results in table, JSON, or XML format

## Installation

You can install pycodestats using pip:

```bash
pip install pycodestats
```

## Usage

To scan a directory and output results in table format:

```bash
pycodestats path/to/your/project
```

To output results in JSON format:

```bash
pycodestats path/to/your/project --json
```

To output results in XML format:

```bash
pycodestats path/to/your/project --xml
```

## Example

```bash
pycodestats src --by-file
```

This will output the statistics for each Python file in the `src` directory.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.
