Как поддержать проект

Спасибо за интерес к проекту! Поспособствовать развитию pynspd можно несколькими способами:

• Поставить ⭐ на GitHub;
• Попробовать pynspd в работе и сообщить о найденных проблемах;
• Поучаствовать в разработке проекта.

Старт для разработки

Для начала разработки вам нужно сделать свой форк репозитория pynspd.

После этого клонировать репозиторий локально, перейти в скачанную папку и запустить скрипт установки:

Внимание: внешняя зависимость

pynspd использует пакетный менеджер uv - невероятно быструю замену pip и многих других инструментов.

Убедитесь, что он установлен перед запуском make-команд.

git clone https://github.com/YOUR-USERNAME/pynspd
cd pynspd
make install

Утилита make для Windows

Если вы пользователь Windows, make нужно установить отдельно. Автор рекомендует использовать для этого пакетный менеджер chocolatey:

choco install make

Async/Sync

Подход к поддержке обоих async/sync API в pynspd был вдохновлен аналогичным в Hishel. Если кратко: мы пишем только асинхронный код, а потом специальным скриптом создаем синхронную версию.

Исходя из этого, от разработчика требуется писать код только в папках **/_async. Синхронный код генерируется при помощи команды:

make unasync

Тестирование и линтинг

Запуск тестов осуществляется при помощи команды:

make tests

Линтинг и форматирование:

make lint

Написание документации

Страницы документации располагаются в папке docs/ проекта.

Для локального разворачивания сайта документации, воспользуйтесь командой:

make docs