Skip to content

Commit 4233361

Browse files
authored
#1 - change folder for module (#8)
1 parent fb4948a commit 4233361

File tree

25 files changed

+70
-22
lines changed

25 files changed

+70
-22
lines changed

.github/workflows/python.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ jobs:
5555
run: uv run pre-commit run --all-files
5656

5757
- name: Test with pytest
58-
run: uv run pytest tests --cov=src
58+
run: uv run pytest --cov=src
5959

6060
- name: Minimize uv cache
6161
run: uv cache prune --ci

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,3 +172,5 @@ cython_debug/
172172

173173
# PyPI configuration file
174174
.pypirc
175+
176+
.idea

.pre-commit-config.yaml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,6 @@ repos:
5757
--wrap-descriptions,
5858
"90",
5959
src,
60-
tests,
6160
]
6261

6362
# bandit - find common security issues
@@ -66,10 +65,8 @@ repos:
6665
hooks:
6766
- id: bandit
6867
name: bandit
69-
exclude: ^tests/
70-
args:
71-
- -r
72-
- src
68+
args: ["-r", "src", "-x", "*/tests/*"]
69+
pass_filenames: false
7370

7471
# prettier - formatting JS, CSS, JSON, Markdown, ...
7572
- repo: https://github.com/pre-commit/mirrors-prettier

shared/utils/README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Shared Utils
2+
3+
Shared utilities and common functionality used across multiple modules in the project.
4+
5+
## Structure
6+
7+
```
8+
shared/utils/
9+
├── src/utils/ # Shared utilities source code
10+
├── pyproject.toml # Package configuration
11+
└── README.md # This file
12+
```
13+
14+
## Overview
15+
16+
This package contains reusable utility functions, helpers, and common code that can be shared between different modules of the application. It provides a centralized location for:
17+
18+
- Common data structures and types
19+
- Utility functions and helpers
20+
- Shared configuration utilities
21+
- Cross-module interfaces and contracts
22+
23+
## Installation
24+
25+
The shared utilities are installed as a local package dependency. To install in development mode:
26+
27+
```bash
28+
pip install -e shared/utils/
29+
```
30+
31+
## Usage
32+
33+
Import utilities from the shared package:
34+
35+
```python
36+
from utils import your_utility_function
37+
# or
38+
from utils.module_name import specific_function
39+
```
40+
41+
## Development
42+
43+
When adding new shared utilities:
44+
45+
1. Place them in the appropriate module under `src/utils/`
46+
2. Update the package's `__init__.py` if needed
47+
3. Add tests for new functionality
48+
4. Update this README if adding major new features
49+
50+
## Dependencies
51+
52+
Check `pyproject.toml` for current dependencies and requirements.

src/core/README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ Core application module providing CLI interface and business logic functionality
55
## 📁 Structure
66

77
```
8-
src/
9-
├── clients/ # HTTP clients and external integrations
10-
├── commands/ # CLI command implementations
11-
├── config/ # Configuration management
12-
│ ├── config.yaml # Application configuration
13-
── logger_config.py
14-
├── exceptions/ # Custom exception classes
15-
├── models/ # Data models and schemas
16-
── config.py # Settings and configuration models
17-
├── services/ # Business logic services
18-
── utils/ # Core utilities
19-
└── main.py # Application entry point
8+
src/
9+
├── core/ # Core module source code
10+
├── clients/ # HTTP clients and external integrations
11+
├── commands/ # CLI command implementations
12+
│ ├── config/ # Configuration management
13+
── core/ # Core functionality
14+
├── exceptions/ # Custom exception classes
15+
├── models/ # Data models and schemas
16+
── services/ # Business logic services
17+
├── utils/ # Core utilities
18+
│ └── main.py # Application entry point
19+
└── tests/ # Core module tests
2020
```
2121

2222
## 🚀 Usage

src/core/pyproject.toml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,5 @@ core = "core.main:entrypoint"
2424
requires = ["hatchling"]
2525
build-backend = "hatchling.build"
2626

27-
[tool.hatch.build.targets.wheel]
28-
packages = ["core"]
29-
3027
[tool.uv.sources]
3128
utils = { workspace = true }

0 commit comments

Comments
 (0)