Лучшая организация мудрого проекта / модуля

Question

Я бы хотел организовать свой проект Sage так, чтобы он отражал лучшие практики. Например, для проектов Python https://www.patricksoftwareblog.com/structure-of-a-python-project/ рекомендует

project_name/  
    project_name/  
        __init__.py  
        ...source code files...  
    test/  
        __init__.py  
        ...unit test files...  
    docs/  
        ...documentation files...  
    project_name.py  
    README.md  
    LICENSE.md  
    requirements.txt  
    .gitignore  

Как изменить эту модель, если я хочу, чтобы пакет, который можно импортировать в Sage, и пример функциональности ноутбука Jupyter демонстрировали?

Answer 1

Применяются общие правила для пакетов Python.

Если хранится в PyPI, пакет можно установить через pip с

$ pip install PACKAGE_NAME

Шаблон для пакета Sage установлен на

• https://github.com/sagemath/sage_sample

с большим количеством советов в README.

См. Также некоторые утилиты в

• https://github.com/sagemath/sage-package