Project Knowledge Extractor
Project description
pk-extractor
pk-extractor (Project Knowledge Extractor) is a tool that generates a comprehensive knowledge base from a given repository, including the project structure and file contents. It respects .gitignore rules and allows for additional exclusion patterns.
Features
- Generates a markdown file containing the project structure and file contents
- Respects
.gitignorerules - Allows for additional file/directory exclusion via command-line arguments
- Provides progress information during processing
- Handles binary files and errors gracefully
Easy to use
- Install the package globally
$ pip install pk-extractor
$ pk-extractor .
- Using pipx
$ pipx run pk-extractor .
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pk_extractor-0.2.3.tar.gz.
File metadata
- Download URL: pk_extractor-0.2.3.tar.gz
- Upload date:
- Size: 3.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9adc6e252c0ae3d45f6a904aba0c5c3dd86a5707837bb38083a80649d7df473f
|
|
| MD5 |
d89bb50622eb4ee5552cb623e9ff4bf1
|
|
| BLAKE2b-256 |
6d3515cb1b30f08e54ae7492c529cc057df9553838869e2ed3ed789ad8e4c406
|
File details
Details for the file pk_extractor-0.2.3-py3-none-any.whl.
File metadata
- Download URL: pk_extractor-0.2.3-py3-none-any.whl
- Upload date:
- Size: 4.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a02c4de5be6a2486b95b21cc7cb52f3a00da15e139fe0c750e337db89c14b780
|
|
| MD5 |
d096f6b4715bdd2bc37506e067155c93
|
|
| BLAKE2b-256 |
0441b37762e4e968aee38ca9f1b8ec2b94825514c4aaded0b50acd748d96f082
|
