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.
1 maintainer
Metadata
1 maintainer
Release files for pk-extractor 0.2.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pk_extractor-0.2.3.tar.gz | 3.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pk_extractor-0.2.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.6 kB
Release files / pk_extractor-0.2.3.tar.gz
| Download URL | pk_extractor-0.2.3.tar.gz |
|---|---|
| Size | 3.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9adc6e252c0ae3d45f6a904aba0c5c3dd86a5707837bb38083a80649d7df473f
|
|
BLAKE2b-256 checksum How to use checksums |
6d3515cb1b30f08e54ae7492c529cc057df9553838869e2ed3ed789ad8e4c406
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.20
|
Release files / pk_extractor-0.2.3-py3-none-any.whl
| Download URL | pk_extractor-0.2.3-py3-none-any.whl |
|---|---|
| Size | 4.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a02c4de5be6a2486b95b21cc7cb52f3a00da15e139fe0c750e337db89c14b780
|
|
BLAKE2b-256 checksum How to use checksums |
0441b37762e4e968aee38ca9f1b8ec2b94825514c4aaded0b50acd748d96f082
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.20
|
