Skip to content

Commit 1cc6827

Browse files
committed
docs: professional collateral and CI setup for v0.1.0 release
1 parent ee7cf83 commit 1cc6827

7 files changed

Lines changed: 143 additions & 1 deletion

File tree

.github/workflows/ci.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
15+
- name: Set up Python
16+
uses: actions/setup-python@v5
17+
with:
18+
python-version: '3.12'
19+
20+
- name: Install uv
21+
run: curl -LsSf https://astral.sh/uv/install.sh | sh
22+
23+
- name: Install dependencies
24+
run: uv sync
25+
26+
- name: Lint with ruff
27+
run: uv run ruff check .
28+
29+
- name: Run tests
30+
run: uv run pytest

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing to agentsrc-py
2+
3+
We welcome contributions! This project uses `uv` for fast, reproducible Python development.
4+
5+
## Setup
6+
7+
1. Install [uv](https://github.com/astral-sh/uv).
8+
2. Clone the repository: `git clone https://github.com/NikitasT2003/agentsrc-py.git`
9+
3. Install dependencies: `uv sync`
10+
4. Run tests to verify setup: `uv run pytest`
11+
12+
## Development Workflow
13+
14+
1. Create a feature branch: `git checkout -b feature/your-feature`
15+
2. Make your changes.
16+
3. Verify formatting and linting: `uv run ruff check .`
17+
4. Run tests: `uv run pytest`
18+
5. Push your branch and open a Pull Request.
19+
20+
## Pull Request Guidelines
21+
22+
- Ensure all tests pass.
23+
- Add new tests for new features.
24+
- Update documentation in `README.md` if necessary.
25+
- We follow the [MIT License](LICENSE).

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Nikitas Tsoumas
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# 📡 agentsrc-py
2+
3+
![agentsrc banner](assets/banner.png)
4+
5+
> **Semantic Signal Extraction for the Age of AI Agents.**
6+
7+
`agentsrc-py` is a powerful, developer-first utility designed to bridge the gap between LLM-based coding agents and the vast ecosystem of Python dependencies. It fetches, unpacks, and analyzes packages to extract high-fidelity semantic summaries, enabling agents to understand complex APIs instantly without reading thousands of lines of source code.
8+
9+
---
10+
11+
## ⚡ Quickstart
12+
13+
Get up and running in seconds:
14+
15+
```bash
16+
# Install with uv (recommended)
17+
uv tool install agentsrc-py
18+
19+
# Initialize a project
20+
agentsrc init
21+
22+
# Sync and analyze your dependencies
23+
agentsrc sync
24+
25+
# Query semantic symbols
26+
agentsrc query search "Pydantic models with validation"
27+
```
28+
29+
## 🛠️ Key Features
30+
31+
- **🎯 Semantic Analysis**: Extracts classes, functions, and docstrings into structured JSON/Markdown.
32+
- **🔌 Plugin System**: Extensible architecture to detect framework-specific patterns (e.g., Pydantic Models).
33+
- **📦 Intelligent Fetching**: Downloads and caches PyPI packages with robust dependency resolution.
34+
- **🔍 Global Symbol Search**: Instantly find any symbol across your entire dependency tree.
35+
- **🚀 Built with uv**: Blazing fast performance and reproducible environments.
36+
37+
## 🏗️ Architecture
38+
39+
The following diagram illustrates how `agentsrc-py` transforms raw PyPI packages into actionable semantic intelligence:
40+
41+
```mermaid
42+
graph TD
43+
A[CLI / API] --> B[ProjectResolver]
44+
B --> C[PackageFetcher]
45+
C --> D[Local Cache]
46+
D --> E[ASTAnalyzer]
47+
E --> F[Framework Plugins]
48+
F --> G[Symbol Map]
49+
G --> H[Semantic Markdown]
50+
```
51+
52+
## 🤝 Contributing
53+
54+
We love contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details on our development workflow and how to get started.
55+
56+
## 📄 License
57+
58+
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
59+
60+
---
61+
62+
<p align="center">
63+
Built with ❤️ for the AI Developer Community.
64+
</p>

git_commit.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
git commit -m "docs: professional collateral and CI setup for v0.1.0 release"

git_push.ps1

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
git push origin master

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[project]
22
name = "agentsrc"
33
version = "0.1.0"
4-
description = "A local developer tool that fetches the exact source code of installed Python packages."
4+
description = "Extract semantic signals for AI Agents from Python dependencies."
55
readme = "README.md"
66
authors = [
77
{ name = "NikitasT2003", email = "tsoumasnikitas@gmail.com" }

0 commit comments

Comments
 (0)