https://github.com/ilbuso/project-stats
Know your project stats
https://github.com/ilbuso/project-stats
lines-of-code python python3
Last synced: about 1 year ago
JSON representation
Know your project stats
- Host: GitHub
- URL: https://github.com/ilbuso/project-stats
- Owner: ilBuso
- License: mit
- Created: 2024-03-02T20:19:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-02T22:58:06.000Z (over 2 years ago)
- Last Synced: 2025-02-05T19:51:10.335Z (over 1 year ago)
- Topics: lines-of-code, python, python3
- Language: Python
- Homepage:
- Size: 8.79 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Project Stats
##### A quick way to know your project stats
## ⇁ TOC
* [About](#about)
* [Installation](#installation)
* [Usage](#usage)
* [Future Implementations](#future-implementations)
* [License](#license)
## ⇁ About
Project Stats is a simple Python script to count the lines of code in a directory. It's useful for getting a quick overview of your project's size. The script recursively goes through all files in the specified directory and counts non-empty lines of code.
## ⇁ Installation
1. Clone the repository:
```sh
git clone https://github.com/ilBuso/project-stats.git
```
2. Change into the `project-stats` directory:
```sh
cd project-stats
```
3. Run the script:
```sh
python project-stats.py
```
## ⇁ Usage
When you run the script, it will prompt you to enter the path to the directory you want to analyze. It will then display the total lines of code in that directory.
```sh
python project-stats.py
Enter the path to the directory: /path/to/your/directory
```
## ⇁ Future Implementations
This project is open for further development. Here are some ideas for future implementations:
- [ ] Display breakdown of file types (e.g. C, C++, h, Makefile)
- [ ] Implement a feature to ignore certain file types or directories
- [ ] Provide an option to save results to a file
## ⇁ Licence
Distributed under the MIT License. See LICENSE for more information.