Skip to content

Commit 4715566

Browse files
committed
Initialize repository structure
1 parent 892bf0a commit 4715566

5 files changed

Lines changed: 117 additions & 0 deletions

File tree

.github/workflows/ci.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
strategy:
13+
matrix:
14+
python-version: ['3.10', '3.11', '3.12']
15+
16+
steps:
17+
- uses: actions/checkout@v4
18+
19+
- name: Set up Python ${{ matrix.python-version }}
20+
uses: actions/setup-python@v5
21+
with:
22+
python-version: ${{ matrix.python-version }}
23+
24+
- name: Install dependencies
25+
run: |
26+
pip install -e ".[dev]"
27+
28+
- name: Lint
29+
run: ruff check .
30+
31+
- name: Type check
32+
run: mypy src/
33+
34+
- name: Test
35+
run: pytest --cov

.gitignore

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Python
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
*.so
6+
.Python
7+
build/
8+
dist/
9+
eggs/
10+
*.egg-info/
11+
*.egg
12+
13+
# Virtual environments
14+
venv/
15+
.venv/
16+
ENV/
17+
18+
# IDE
19+
.idea/
20+
.vscode/
21+
*.swp
22+
*.swo
23+
24+
# Testing
25+
.pytest_cache/
26+
.coverage
27+
htmlcov/
28+
.mypy_cache/
29+
30+
# Build artifacts
31+
*.db
32+
*.sqlite

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# cdl-parser
2+
3+
Part of the [Gemmology Project](https://gemmology.dev).
4+
5+
## Installation
6+
7+
```bash
8+
pip install cdl-parser
9+
```
10+
11+
## Documentation
12+
13+
See [cdl-parser.gemmology.dev](https://cdl-parser.gemmology.dev) for full documentation.
14+
15+
## License
16+
17+
MIT License - see [LICENSE](LICENSE) for details.

pyproject.toml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[project]
2+
name = "cdl-parser"
3+
version = "0.1.0"
4+
description = "Part of the Gemmology Project"
5+
readme = "README.md"
6+
license = { text = "MIT" }
7+
requires-python = ">=3.10"
8+
dependencies = []
9+
10+
[project.urls]
11+
Homepage = "https://cdl-parser.gemmology.dev"
12+
Repository = "https://github.com/gemmology-dev/cdl-parser"
13+
14+
[project.optional-dependencies]
15+
dev = ["pytest>=7.0", "pytest-cov", "ruff", "mypy"]
16+
17+
[build-system]
18+
requires = ["setuptools>=61.0"]
19+
build-backend = "setuptools.build_meta"
20+
21+
[tool.setuptools.packages.find]
22+
where = ["src"]
23+
24+
[tool.ruff]
25+
line-length = 100
26+
target-version = "py310"
27+
28+
[tool.mypy]
29+
python_version = "3.10"
30+
strict = true

src/cdl_parser/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
"""cdl-parser - Part of the Gemmology Project."""
2+
3+
__version__ = "0.1.0"

0 commit comments

Comments
 (0)