Skip to content

Commit

Permalink
Project clean up.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Dec 25, 2024
1 parent b81524d commit 3ef5d52
Show file tree
Hide file tree
Showing 8 changed files with 471 additions and 338 deletions.
6 changes: 1 addition & 5 deletions .python-version
Original file line number Diff line number Diff line change
@@ -1,5 +1 @@
3.13.0
3.12.6
3.11.10
3.10.15
3.9.20
3.11
1 change: 0 additions & 1 deletion .ruff.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ target-version = "py311"
preview = true
extend-select = [
"E305", # 2 blank lines before class or function
"E501",
]
select = [
"ARG", # unused arguments
Expand Down
34 changes: 20 additions & 14 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ UV := uv
UVX := uvx --isolated
UV_PIP := $(UV) pip
UV_RUN := $(UV) run

UV_SYNC := $(UV) sync

# -- Clean Up ------------------------------------------------------------------

Expand All @@ -35,12 +35,8 @@ build: ## Build the distribution package using uv
$(UV_PIP) install dist/splitme_ai-0.1.0-py3-none-any.whl

.PHONY: install
install: ## Install all project dependencies
$(UV_PIP) install -r pyproject.toml --all-extras

.PHONY: install-editable
install-editable:: ## Install all project dependencies in editable mode
$(UV_PIP) install -e ".[dev,docs,lint,test]"
install: ## Install all dependencies from pyproject.toml
$(UV_SYNC) --dev --group test --group docs --group lint --all-extras

.PHONY: lock
lock: ## Lock dependencies declared in pyproject.toml
Expand All @@ -53,7 +49,11 @@ requirements: ## Generate requirements files from pyproject.toml

.PHONY: sync
sync: ## Sync environment with pyproject.toml
uv sync --all-groups --dev
$(UV_SYNC) --all-groups --dev

.PHONY: update
update: ## Update all dependencies from pyproject.toml
uv lock --upgrade

.PHONY: venv
venv: ## Create a virtual environment
Expand All @@ -64,10 +64,8 @@ venv: ## Create a virtual environment

.PHONY: docs
docs: ## Build documentation site using mkdocs
# $(UV_RUN) mkdocs build
# $(UV_RUN) mkdocs serve
uvx --with mkdocs-material mkdocs serve

$(UV_RUN) mkdocs serve
# uvx --with mkdocs-material mkdocs serve

# -- Linting ---------------------------------------------------------------

Expand All @@ -85,8 +83,16 @@ lint: ## Lint Python files using Ruff
@echo -e "\n ►Running the Ruff linter..."
$(UVX) ruff check $(TARGET) --fix --config .ruff.toml

.PHONY: format-lint
format-lint: format lint ## Format and lint Python files
.PHONY: format-and-lint
format-and-lint: format lint ## Format and lint Python files

.PHONY: mypy
mypy: ## Type-check Python files using MyPy
$(UV_RUN) mypy $(TARGET)

.PHONY: pyright
pyright: ## Type-check Python files using Pyright
$(UV_RUN) pyright $(TARGET)


# -- Utilities ------------------------------------------------------------------
Expand Down
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,16 @@

<!-- HEADER -->
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/eli64s/splitme-ai/216a92894e6f30c707a214fad5a5fba417e3bc39/docs/assets/logo.svg" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/eli64s/splitme-ai/216a92894e6f30c707a214fad5a5fba417e3bc39/docs/assets/logo.svg" />
<img alt="splitme-ai logo" src="https://raw.githubusercontent.com/eli64s/splitme-ai/216a92894e6f30c707a214fad5a5fba417e3bc39/docs/assets/logo.svg" width="800px" style="max-width: 100%;" />
<source media="(prefers-color-scheme: dark)" srcset="docs/assets/logo-dark.svg">
<source media="(prefers-color-scheme: light)" srcset="docs/assets/logo-light.svg">
<img alt="SplitMe-AI Logo" src="docs/assets/logo-light.svg" width="800" style="max-width: 100%;">
</picture>

<!--
<img src="docs/assets/logo-light.svg#gh-light-mode-only" alt="SplitMe-AI Logo Light" width="800" style="max-width: 100%;">
<img src="docs/assets/logo-dark.svg#gh-dark-mode-only" alt="SplitMe-AI Logo Dark" width="800" style="max-width: 100%;">
-->

<h3 align="center">
Break down your docs. Build up your knowledge.
</h3>
Expand Down Expand Up @@ -77,15 +82,15 @@ pip install -U splitme-ai
Install in an isolated environment with [pipx][pipx]:

```sh
❯ pipx install readmeai
❯ pipx install splitme-ai
```

#### <img width="2%" src="https://simpleicons.org/icons/uv.svg">&emsp13;uv

For the fastest installation use [uv][uv]:

```sh
❯ uv tool install splitme
❯ uv tool install splitme-ai
```

### Usage
Expand Down
53 changes: 53 additions & 0 deletions docs/assets/logo-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 53 additions & 0 deletions docs/assets/logo-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ requires = [ "hatch-fancy-pypi-readme>=22.5", "hatchling" ]

[project]
name = "splitme-ai"
version = "0.1.6"
version = "0.1.7"
description = "Break down docs, build up knowledge."
readme = "README.md"
keywords = [
Expand All @@ -21,7 +21,7 @@ keywords = [
]
license = "MIT"
authors = [ { name = "Eli Salamie", email = "egsalamie@gmail.com" } ]
requires-python = ">=3.9"
requires-python = ">=3.9, <=3.13"
classifiers = [
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.9",
Expand All @@ -31,9 +31,11 @@ classifiers = [
"Programming Language :: Python :: 3.13",
]
dependencies = [
"aiofiles>=24.1.0",
"pydantic>=2.10.3",
"pydantic-settings>=2.6.1",
"pyyaml>=6.0.2",
"toml>=0.10.2 ; python_full_version < '3.11'",
]

optional-dependencies.ai = [
Expand Down Expand Up @@ -68,6 +70,7 @@ lint = [
"mypy>=1.14",
"pyright>=1.1.391",
"ruff>=0.8.4",
"types-aiofiles>=24.1.0.20241221",
"types-pyyaml>=6.0.12.20240917",
]

Expand Down
Loading

0 comments on commit 3ef5d52

Please sign in to comment.