diff --git a/.github/workflows/checks.yml b/.github/workflows/checks.yml index 35b3b96..096e366 100644 --- a/.github/workflows/checks.yml +++ b/.github/workflows/checks.yml @@ -23,7 +23,8 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - python -m pip install -r .github/workflows/requirements.txt + python -m pip install -r requirements.txt + python -m pip install mypy pytest - name: Run MyPy run: | diff --git a/README.md b/README.md index 789dc97..eb26b2d 100644 --- a/README.md +++ b/README.md @@ -20,17 +20,17 @@ - [Example](#example) -## Introduction +## Introduction -**CuteKit** is a simple - yet - powerful build system and package manager for C and C++. It: +**CuteKit** is a simple - yet - powerful build system and package manager for C and C++. It: - ✨ It uses **JSON**: Cutekit uses JSON instead of introducing a whole new programming language for describing the project. And also has macros to help the user experience (see [Jexpr](doc/spec/jexpr.md)). - ✨ It's a **package manager**: Cutekit package manager is based on **Git**, nothing is centralized. -- ✨ It's **extendible**: Cutekit can be [extended](./doc/extends.md) by writing custom Python plugins. +- ✨ It's **extendible**: Cutekit can be [extended](./doc/extends.md) by writing custom Python plugins. - ✨ It's **easy**: the [**templates**](./doc/templates.md) help the user quick-start a project. - ✨ It's **portable**: Cutekit can run on MacOS Gnu/Linux and Windows. -## Installation +## Installation To install Cutekit, you may use your favourite package manager if it is available. Or you can install it manually by following the instructions below. @@ -45,13 +45,13 @@ $ cd cutekit $ pip install --user -e . ``` -## Quick-start +## Quick-start --> If you directly want to start using Cutekit for a new project, you can just run `$ ck I host` and it will create a new project in the host directory (you can rename it later). +-> If you directly want to start using Cutekit for a new project, you can just run `$ ck I host` and it will create a new project in the host directory (you can rename it later). -> If you want to use Cutekit for writing operating systems, you can create a new [limine](https://github.com/limine-bootloader/limine/)-based project by running `$ ck I limine-barebone`. -## Example +## Example If you want to see how it works you can read the [doc/cutekit.md](doc/cutekit.md) file. diff --git a/pyproject.toml b/pyproject.toml index 6b6e67f..14384a5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,12 +14,7 @@ authors = [ readme = "README.md" requires-python = ">=3.10" license = { text = "MIT" } -dependencies = [ - "requests ~= 2.31.0", - "graphviz ~= 0.20.1", - "dataclasses-json ~= 0.6.2", -] -dynamic = ["version"] +dynamic = ["version", "dependencies"] [project.scripts] ck = "cutekit:main" @@ -31,6 +26,7 @@ packages = ["cutekit"] [tool.setuptools.dynamic] version = { attr = "cutekit.const.VERSION" } +dependencies = { file = ["requirements.txt"] } [tool.setuptools.package-data] "cutekit" = ["py.typed"] diff --git a/.github/workflows/requirements.txt b/requirements.txt similarity index 68% rename from .github/workflows/requirements.txt rename to requirements.txt index 3055127..892a2bf 100644 --- a/.github/workflows/requirements.txt +++ b/requirements.txt @@ -1,5 +1,4 @@ requests ~= 2.31.0 graphviz ~= 0.20.1 dataclasses-json ~= 0.6.2 -mypy ~= 1.7.0 -pytest ~= 7.4.3 +docker ~= 6.1.3