Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,18 @@ jobs:

steps:
- name: Checkout code
uses: actions/checkout@v3
uses: actions/checkout@v4

- name: Set up Python 3.10
uses: actions/setup-python@v4
with:
python-version: '3.10'

- name: Install uv
run: pipx install uv

- name: Install dependencies
run: |
pip install --upgrade pip
pip install -e .[dev]
run: uv pip install -e .[dev] --system

- name: Run tests
run: pytest
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Publish to TestPyPI
name: Publish to PyPI

on:
push:
Expand Down
21 changes: 20 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,29 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.1.0] - 2025-09-15

### Added
- A comprehensive developer API for using `Scriber` as a library.
- The `Scriber` class can now be initialized with a list of paths to scan multiple directories at once.
- `Scriber` can now be initialized with a configuration dictionary directly.
- New method `get_output_as_string()` to get the project map without writing to a file.
- New getter methods `get_tree()` and `get_mapped_files()` to access processed data.
- Expanded `README.md` with a detailed "Library Usage" section and API examples.
- Created two installation options: a minimal default (`project-scriber`) and an enhanced version with rich terminal output (`project-scriber[rich]`).
- The `Scriber` class is now exposed for direct import and programmatic use (`from scriber import Scriber`).
- A `hidden` configuration option to prevent a file's content from being written to the output, while still including it in the file tree.
This is useful for large files like `poetry.lock`.
- Added a prompt for `hidden` patterns to the interactive `scriber init` command.

### Changed
- The default installation no longer includes `rich` as a dependency, making it more lightweight.
The CLI now falls back to simple text-based output if `rich` is not installed.
- Improved performance of file analysis by using multi-threading to process files concurrently.

## [1.0.1] - 2025-08-30

### Added
Expand Down
Loading