devscript 0.1.1__py3-none-any.whl → 0.2.0__py3-none-any.whl

{devscript-0.1.1.dist-info → devscript-0.2.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: devscript
-Version: 0.1.1
-Summary: A utility for managing custom development scripts via JSON or TOML configuration
+Version: 0.2.0
+Summary: A utility for managing custom development scripts pyproject.toml configuration
 Author-email: "Маг Ильяс DOMA (MagIlyasDOMA)" <magilyas.doma.09@list.ru>
 License: GPL-3.0-only
 Project-URL: Homepage, https://github.com/MagIlyasDOMA/devscript
@@ -9,19 +9,15 @@ Project-URL: Repository, https://github.com/MagIlyasDOMA/devscript.git
 Project-URL: BugTracker, https://github.com/MagIlyasDOMA/devscript/issues
 Keywords: cli,scripts
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.8
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: pyyaml>=6.0.3
 Dynamic: license-file
 
 <a id="doc_en"></a>
@@ -45,66 +41,15 @@ cd devscript
 pip install -e .
 ```
 
-### TypeScript version
-```shell
-npm install -D @hren/devscript
-# or
-yarn add -D @hren/devscript
-# or
-pnpm add -D @hren/devscript
-```
-
-#### Or install from source:
-
-```shell
-git clone https://github.com/MagIlyasDOMA/devscript.git
-cd devscript
-npm install
-npm run build
-npm link
-```
-
-### Configuration formats
-#### JSON (`devscript.json`)
-```json
-{
-  "$schema": "https://raw.githubusercontent.com/MagIlyasDOMA/devscript/refs/heads/main/schema.json",
-  "build": "python -m build",
-  "test": "pytest tests/",
-  "lint": "flake8 src/",
-  "dev": "python -m app --debug"
-}
-```
-
-#### YAML (`devscript.yaml`)
-```yaml
-build: "python -m build"
-test: "pytest tests/"
-lint: "flake8 src/"
-dev: "python -m app --debug"
-```
-
-#### TOML (`pyproject.toml`)
+### Configuration format
 ```toml
-[devscript]
+[tool.devscript]
 build = "python -m build"
 test = "pytest tests/"
 lint = "flake8 src/"
 dev = "python -m app --debug"
 ```
 
-#### `package.json`
-```json
-{
-  "devscript": {
-    "build": "python -m build",
-    "test": "pytest tests/",
-    "lint": "flake8 src/",
-    "dev": "python -m app --debug"
-  }
-}
-```
-
 ### Running commands
 #### The package provides four CLI commands:
 - `devscript` — full name
@@ -126,13 +71,12 @@ dvs lint
 # Pass arguments to a command
 devscript dev --port 8000 --reload
 ```
-Here is the translation of the text into English, with the markdown formatting preserved:
 
 ## Examples
 ### Example 1: Basic usage
 ```toml
 # pyproject.toml
-[devscript]
+[tool.devscript]
 start = "uvicorn main:app --reload"
 migrate = "alembic upgrade head"
 shell = "ipython"
@@ -145,11 +89,10 @@ devs shell      # Starts IPython
 ```
 
 ### Example 2: Passing arguments
-```json
-{
-  "test": "pytest",
-  "cov": "pytest --cov=src"
-}
+```toml
+[tool.devscript]
+test = "pytest"
+cov = "pytest --cov=src"
 ```
 
 ```shell
@@ -174,42 +117,12 @@ devs test
 devs lint
 ```
 
-### TypeScript version
-```shell
-# Clone the repository
-git clone https://github.com/MagIlyasDOMA/devscript.git
-cd devscript
-
-# Install dependencies
-npm install
-
-# Build the project
-npm run build
-
-# Install in development mode
-npm link
-
-# Run tests
-devs test
-
-# Run linter
-devs lint
-```
-
 ## Project structure
 ```text
 devscript/
-├── python/                 # Python implementation
-│   ├── devscript/
-│   │   ├── __init__.py
-│   │   └── py.typed
-│   ├── pyproject.toml
-│   └── README.md
-├── typescript/             # TypeScript implementation
-│   ├── devscript.ts
-│   ├── package.json
-│   ├── tsconfig.json
-│   └── README.md
+├── devscript.py            # Python implementation
+├── pyproject.toml
+├── README.md
 ├── schema.json             # JSON Schema for autocompletion
 └── LICENSE
 ```
@@ -233,25 +146,11 @@ print("Available commands:", core.commands_list())
 core.run("build", ["--verbose"])
 ```
 
-#### Typescript
-```typescript
-import { DevScriptCore } from 'devscript';
-```
-```javascript
-const core = new DevScriptCore();
-console.log("Available commands:", core.commands_list());
-core.run("build", ["--verbose"]);
-```
-
 ## Requirements
 ### Python version
-- Python 3.8 or higher
+- Python 3.11 or higher
 - No external dependencies (uses the standard library)
 
-### TypeScript version
-- Node.js 14 or higher
-- Dependencies: argparse, smol-toml
-
 ## License
 GPL-3.0-only
 
@@ -267,20 +166,6 @@ GPL-3.0-only
 4. Push to the branch (`git push origin feature/amazing-feature`)
 5. Open a Pull Request
 
-## Frequently Asked Questions
-##### Q: Can I use both versions at the same time?
-A: Yes, they do not conflict as they use different commands for installation (pip vs npm).
-
-##### Q: Are other configuration formats supported?
-A: Currently, JSON, YAML, pyproject.toml, and package.json are supported.
-
-##### Q: How do I add a new command?
-A: Just add a new entry in the configuration file with the command name and the corresponding shell command.
-
-##### Q: Does it work on Windows?
-A: Yes, both versions have been tested on Windows.
-
-
 ---
 
 <a id="doc_ru"></a>
@@ -304,66 +189,15 @@ cd devscript
 pip install -e .
 ```
 
-### TypeScript версия
-```shell
-npm install -D @hren/devscript
-# или
-yarn add -D @hren/devscript
-# или
-pnpm add -D @hren/devscript
-```
-
-#### Или установка из исходного кода:
-
-```shell
-git clone https://github.com/MagIlyasDOMA/devscript.git
-cd devscript
-npm install
-npm run build
-npm link
-```
-
-### Форматы конфигурации
-#### JSON (`devscript.json`)
-```json
-{
-  "$schema": "https://raw.githubusercontent.com/MagIlyasDOMA/devscript/refs/heads/main/schema.json",
-  "build": "python -m build",
-  "test": "pytest tests/",
-  "lint": "flake8 src/",
-  "dev": "python -m app --debug"
-}
-```
-
-#### YAML (`devscript.yaml`)
-```yaml
-build: "python -m build"
-test: "pytest tests/"
-lint: "flake8 src/"
-dev: "python -m app --debug"
-```
-
-#### TOML (`pyproject.toml`)
+### Формат конфигурации
 ```toml
-[devscript]
+[tool.devscript]
 build = "python -m build"
 test = "pytest tests/"
 lint = "flake8 src/"
 dev = "python -m app --debug"
 ```
 
-#### `package.json`
-```json
-{
-  "devscript": {
-    "build": "python -m build",
-    "test": "pytest tests/",
-    "lint": "flake8 src/",
-    "dev": "python -m app --debug"
-  }
-}
-```
-
 ### Запуск команд
 #### Пакет предоставляет четыре CLI-команды:
 - `devscript` — полное имя
@@ -390,7 +224,7 @@ devscript dev --port 8000 --reload
 ### Пример 1: Базовое использование
 ```toml
 # pyproject.toml
-[devscript]
+[tool.devscript]
 start = "uvicorn main:app --reload"
 migrate = "alembic upgrade head"
 shell = "ipython"
@@ -403,11 +237,10 @@ devs shell      # Запускает IPython
 ```
 
 ### Пример 2: Передача аргументов
-```json
-{
-  "test": "pytest",
-  "cov": "pytest --cov=src"
-}
+```toml
+[tool.devscript]
+test = "pytest"
+cov = "pytest --cov=src"
 ```
 
 ```shell
@@ -432,42 +265,12 @@ devs test
 devs lint
 ```
 
-### TypeScript версия
-```shell
-# Клонировать репозиторий
-git clone https://github.com/MagIlyasDOMA/devscript.git
-cd devscript
-
-# Установить зависимости
-npm install
-
-# Собрать проект
-npm run build
-
-# Установить в режиме разработки
-npm link
-
-# Запустить тесты
-devs test
-
-# Запустить линтер
-devs lint
-```
-
 ## Структура проекта
 ```text
 devscript/
-├── python/                 # Python реализация
-│   ├── devscript/
-│   │   ├── __init__.py
-│   │   └── py.typed
-│   ├── pyproject.toml
-│   └── README.md
-├── typescript/             # TypeScript реализация
-│   ├── devscript.ts
-│   ├── package.json
-│   ├── tsconfig.json
-│   └── README.md
+├── devscript.py            # Python-реализация
+├── pyproject.toml
+├── README.md
 ├── schema.json             # JSON Schema для автодополнения
 └── LICENSE
 ```
@@ -491,24 +294,11 @@ print("Доступные команды:", core.commands_list())
 core.run("build", ["--verbose"])
 ```
 
-#### Typescript
-```typescript
-import { DevScriptCore } from 'devscript';
-
-const core = new DevScriptCore();
-console.log("Доступные команды:", core.commands_list());
-core.run("build", ["--verbose"]);
-```
-
 ## Требования
 ### Python версия
-- Python 3.8 или выше
+- Python 3.11 или выше
 - Нет внешних зависимостей (использует стандартную библиотеку)
 
-### TypeScript версия
-- Node.js 14 или выше
-- Зависимости: argparse, smol-toml
-
 ## Лицензия
 GPL-3.0-only
 
@@ -523,16 +313,3 @@ GPL-3.0-only
 3. Закоммитьте изменения (`git commit -m 'Add some amazing feature'`)
 4. Запушьте в ветку (`git push origin feature/amazing-feature`)
 5. Откройте Pull Request
-
-## Часто задаваемые вопросы
-##### Q: Могу ли я использовать обе версии одновременно?
-A: Да, они не конфликтуют, так как используют разные команды для установки (pip vs npm).
-
-##### Q: Поддерживаются ли другие форматы конфигурации?
-A: В данный момент поддерживаются JSON, YAML, pyproject.toml и package.json
-
-##### Q: Как добавить новую команду?
-A: Просто добавьте новую запись в конфигурационный файл с именем команды и соответствующей shell-командой.
-
-##### Q: Работает ли на Windows?
-A: Да, обе версии протестированы на Windows.

devscript-0.2.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+devscript.py,sha256=_M_bjoTv_u8cw8GSJ4lU4_1JmoZtCCW16SYv5TpddwA,1128
+devscript-0.2.0.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+devscript-0.2.0.dist-info/METADATA,sha256=AosfxA0RuhHEHxWg-lHABMyAXoQBMP_J7WrxQwY7IRI,8404
+devscript-0.2.0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+devscript-0.2.0.dist-info/entry_points.txt,sha256=npG9JMkfk8V9pQZwLKU1mb5L7P5nceGF7gB4VuSEM1c,112
+devscript-0.2.0.dist-info/top_level.txt,sha256=Tk3VhyXXyXV8jxju8RTKMKYivzFb_496RWF5YfocI5g,10
+devscript-0.2.0.dist-info/RECORD,,

{devscript-0.1.1.dist-info → devscript-0.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (82.0.1)
+Generator: setuptools (83.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

devscript.py

@@ -0,0 +1,35 @@
+import argparse, os, tomllib
+from dataclasses import dataclass
+from typing import Literal
+
+__version__ = '0.2.0'
+
+
+class DevScriptCore:
+    def __init__(self):
+        try: self.config = self.read_config()['tool']['devscript']
+        except KeyError: raise FileNotFoundError('Config not found')
+
+    @staticmethod
+    def read_config() -> dict:
+        if os.path.isfile('pyproject.toml'):
+            with open('pyproject.toml', 'rb') as file: return tomllib.load(file)
+        else: raise FileNotFoundError('Config not found')
+
+    def commands_list(self): return self.config.keys()
+
+    def run(self, command: str, argv: list[str]):
+        if command not in self.commands_list():
+            raise ValueError(f'Invalid command: {command}')
+        os.system(' '.join([self.config[command]] + argv))
+
+
+def main():
+    core = DevScriptCore()
+    parser = argparse.ArgumentParser()
+    parser.add_argument('command', type=str, help='script to run', choices=core.commands_list())
+    args, argv = parser.parse_known_args()
+    core.run(args.command, argv)
+
+
+if __name__ == '__main__': main()

devscript/__init__.py

@@ -1,69 +0,0 @@
-import argparse, os, json, tomllib, yaml
-from dataclasses import dataclass
-from typing import Literal
-
-__version__ = '0.1.0'
-
-
-@dataclass
-class DevScriptConfig:
-    type: Literal['json', 'toml', 'npmjs', 'yaml']
-    data: dict
-
-
-class DevScriptCore:
-    def __init__(self):
-        self._config_obj = self.read_config()
-        try:
-            if self._config_obj.type == 'json':
-                self.config = self._config_obj.data
-                self._config_file = 'devscript.json'
-            elif self._config_obj.type == 'yaml':
-                self.config = self._config_obj.data
-                self._config_file = 'devscript.yaml'
-            elif self._config_obj.type == 'toml':
-                self.config = self._config_obj.data['devscript']
-                self._config_file = 'pyproject.toml'
-            elif self._config_obj.type == 'npmjs':
-                self.config = self._config_obj.data['devscript']
-                self._config_file = 'package.json'
-            else: raise FileNotFoundError('Config not found')
-        except KeyError:
-            raise FileNotFoundError('Config not found')
-
-    @staticmethod
-    def read_config() -> DevScriptConfig:
-        if os.path.isfile('devscript.json'):
-            with open('devscript.json', encoding='utf-8') as file:
-                data = json.load(file)
-                if '$schema' in data: del data['$schema']
-                return DevScriptConfig('json', data)
-        elif os.path.isfile('devscript.yaml'):
-            with open('devscript.yaml', encoding='utf-8') as file:
-                return DevScriptConfig('yaml', yaml.safe_load(file))
-        elif os.path.isfile('pyproject.toml'):
-            with open('pyproject.toml', 'rb') as file:
-                return DevScriptConfig('toml', tomllib.load(file))
-        elif os.path.isfile('package.json'):
-            with open('package.json', 'r', encoding='utf-8') as file:
-                return DevScriptConfig('npmjs', json.load(file))
-        else: raise FileNotFoundError('Config not found')
-
-    def commands_list(self):
-        return self.config.keys()
-
-    def run(self, command: str, argv: list[str]):
-        if command not in self.commands_list():
-            raise ValueError(f'Invalid command: {command}')
-        os.system(' '.join([self.config[command]] + argv))
-
-
-def main():
-    core = DevScriptCore()
-    parser = argparse.ArgumentParser()
-    parser.add_argument('command', type=str, help='script to run', choices=core.commands_list())
-    args, argv = parser.parse_known_args()
-    core.run(args.command, argv)
-
-
-if __name__ == '__main__': main()

devscript-0.1.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-devscript/__init__.py,sha256=TdCIcN4tQLTCQXxZH-Vb6nKg1Z9b38VV9NQDHWnUH7c,2672
-devscript-0.1.1.dist-info/licenses/LICENSE,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-devscript-0.1.1.dist-info/METADATA,sha256=lYerkXe3OeJyorb3h0O_BS8c_Ymcr8f5SjTQxmJGVrk,14005
-devscript-0.1.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-devscript-0.1.1.dist-info/entry_points.txt,sha256=npG9JMkfk8V9pQZwLKU1mb5L7P5nceGF7gB4VuSEM1c,112
-devscript-0.1.1.dist-info/top_level.txt,sha256=Tk3VhyXXyXV8jxju8RTKMKYivzFb_496RWF5YfocI5g,10
-devscript-0.1.1.dist-info/RECORD,,