SAME-Project / same-project

SAME Project

This is the central repository for the development of the SAME project.

Getting Started

For instructions on how to install a standalone version of SAME, see the getting started guide. If you're a developer, see the developer documentation for instructions on how to build, run and test the codebase.

Project Structure

The project is laid out as follows:

• /docs: Documentation website for the SAME project.
• /sameproject: Python codebase containing the implementation of the SAME project.
• /cli: Python implmentation of the same CLI tool for compiling Jupyter notebooks against target DevOps backends.
• /sdk: Experimental python module for making Jupyter notebooks easier to integrate into DevOps backends.
• /test: Unit tests and integration tests for the python codebase.
• /scripts: Useful scripts for development and testing.

Releasing

To publish a release to PyPI, run:

poetry publish --build

The version number of the release is defined in pyproject.toml.