Skip to content

Commit 92d1491

Browse files
committed
new file: CHANGELOG.md
modified: README.md
1 parent c59f1f9 commit 92d1491

File tree

2 files changed

+74
-76
lines changed

2 files changed

+74
-76
lines changed

β€ŽCHANGELOG.mdβ€Ž

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Changelog
2+
3+
## [1.1.0] - 2025-01-06
4+
5+
### Added
6+
- Extended file type support for `.xlsx`, `.xls`, `.pptx`, `.json`, `.csv`, `.xml`
7+
- Semantic compression feature with configurable levels
8+
- Comprehensive compliance framework
9+
- Detailed risk assessment workflow
10+
- Enhanced PII analysis capabilities
11+
12+
### Changed
13+
- Improved file processing logic
14+
- Refined compliance and regulatory detection
15+
- Updated documentation with more detailed usage instructions
16+
17+
### Fixed
18+
- Encoding detection improvements
19+
- Handling of complex directory structures
20+
- Performance optimizations for large document sets
21+
22+
## [1.0.0] - 2024-12-01
23+
24+
### Initial Release
25+
- Multi-format document ingestion
26+
- Compliance-focused processing
27+
- Basic file type support
28+
- Command-line and Python package interfaces
29+
- Metadata and reporting features

β€ŽREADME.mdβ€Ž

Lines changed: 45 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,29 @@ docsingest /path/to/documents -v
8888

8989
### Advanced Features
9090

91+
92+
#### Comeplete Options List
93+
```bash
94+
usage: docsingest [-h] [-o OUTPUT] [--agent AGENT] [-p PROMPT] [--no-pii-analysis] [-v] [--compress] [--compression-level COMPRESSION_LEVEL] directory
95+
96+
Ingest documents from a directory for AI context.
97+
98+
positional arguments:
99+
directory Path to the directory containing documents
100+
101+
options:
102+
-h, --help show this help message and exit
103+
-o OUTPUT, --output OUTPUT
104+
Output markdown file path (default: document_context.md)
105+
--agent AGENT Initial AI agent prompt (default: Comprehensive Compliance Prompt)
106+
-p PROMPT, --prompt PROMPT
107+
Alternate initial AI agent prompt
108+
--no-pii-analysis Disable PII analysis
109+
-v, --verbose Enable verbose output
110+
--compress Compress document content
111+
--compression-level COMPRESSION_LEVEL
112+
Compression level (0-1)
113+
```
91114
#### Content Compression
92115
```bash
93116
# Enable content compression
@@ -177,64 +200,28 @@ DocsIngest provides a robust, multi-layered approach to regulatory compliance an
177200
- Identification of sensitive and regulated content
178201
- Contextual risk scoring
179202

180-
2. **Compliance Risk Evaluation**
181-
- Detect potential regulatory violations
182-
- Flag documents with high-risk content
183-
- Generate detailed compliance reports
184-
185-
3. **Proactive Monitoring**
186-
- Continuous document scanning
187-
- Real-time alerts for compliance breaches
188-
- Audit trail generation
189-
190-
### πŸ”’ Supported Compliance Domains
191-
- GDPR (General Data Protection Regulation)
192-
- HIPAA (Health Insurance Portability and Accountability Act)
193-
- CCPA (California Consumer Privacy Act)
194-
- SOX (Sarbanes-Oxley Act)
195-
- PCI DSS (Payment Card Industry Data Security Standard)
196-
- NIST Framework
197-
- ISO 27001 Information Security Management
198-
199-
### 🚨 Key Compliance Capabilities
200-
- **Advanced PII Detection**
201-
- Identify sensitive personal information
202-
- Support for multiple PII categories:
203-
* Names
204-
* Email addresses
205-
* Phone numbers
206-
* Social Security Numbers
207-
* Credit card numbers
208-
- **Intelligent Redaction**
209-
- Automatic masking of sensitive information
210-
- Configurable redaction levels
211-
- **Comprehensive Compliance Reporting**
212-
- Detailed risk assessment
213-
- Actionable compliance recommendations
214-
- **Multi-Regulation Support**
215-
- Compliance checks for GDPR, FERPA, COPPA
216-
- Proactive regulatory alignment
217-
218-
### πŸ” Compliance Verification Process
219-
1. Document Ingestion
220-
2. Automated PII Scanning
221-
3. Risk Assessment and Scoring
222-
4. Compliance Reporting
223-
5. Optional Redaction
224-
225-
**Note**: While DocsIngest provides powerful compliance tools, it is not a substitute for professional legal or compliance advice. Always consult with compliance experts for your specific regulatory requirements.
226-
227-
## πŸ“‹ Changelog
228-
229-
### Version 0.1.21
230-
- Added `.docsingest_ignore` support for flexible file and directory exclusion
231-
- Implemented content compression with configurable levels
232-
- Enhanced compliance and PII detection capabilities
233-
- Improved multi-format document support
234-
- Added more robust error handling and logging
235-
236-
### Previous Versions
237-
- See [GitHub Releases](https://github.com/marc-shade/docsingest/releases) for detailed changelog
203+
## πŸ“¦ Version Information
204+
205+
**Current Version**: 1.1.0
206+
**Last Updated**: 2025-01-06
207+
**Maintained by**: Marc Shade (marc@2acrestudios.com)
208+
209+
## 🀝 Contributing
210+
211+
As the primary developer, I manage this project with a focus on continuous improvement and innovation. Contributions are welcome through collaborative discussions and iterative development.
212+
213+
## πŸ“„ License
214+
215+
Proprietary software. All rights reserved.
216+
217+
## πŸš€ Roadmap
218+
219+
- [x] Support more file types
220+
- [ ] Enhanced token estimation
221+
- [ ] Web interface
222+
- [ ] Cloud storage integration
223+
- [ ] Advanced AI prompt customization
224+
- [ ] Support for additional specialized file formats (e.g., .rtf, .odt)
238225

239226
## πŸ”§ Development
240227

@@ -253,21 +240,3 @@ pip install -r requirements-dev.txt
253240

254241
# Run tests
255242
pytest tests/
256-
```
257-
258-
## 🀝 Contributing
259-
260-
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
261-
262-
## πŸ“„ License
263-
264-
MIT License
265-
266-
## πŸš€ Roadmap
267-
268-
- [x] Support more file types
269-
- [ ] Enhanced token estimation
270-
- [ ] Web interface
271-
- [ ] Cloud storage integration
272-
- [ ] Advanced AI prompt customization
273-
- [ ] Support for additional specialized file formats (e.g., .rtf, .odt)

0 commit comments

Comments
Β (0)