Add pyproject.toml so that other projects can reference it

[youngjoon-lee]

Motivation

Some Python packages in this repo need to be referenced by other projects such as nomos-simulations.

Although the simulations and PoCs need to be done in prior to writing executable specs in this repo, some simulations need to be based on existing specs defined in repo. For example, the mixnet simulation is based on some code in this repo that was defined long time ago.

So, instead of maintaining the same code in different repos, I made this repo can be referenced by other projects.

Changes.

I added pyproject.toml. Although we are not going to publish this repo to PyPI right now, we need this file, so that other projects can reference it by specifying the following dependency in their requirements.txt.

git+https://github.com/logos-co/nomos-specs.git@{branch-name}

Then, they can import packages like:

from mixnet.config import MixnetConfig

This pyproject.toml includes only Python packages (mixnet, cryptarchia, da), not Rust packages (cl, goas).

I tested this in my local. The related PR is coming soon in the nomos-simulations repo.

Notes

According to PEP 8 style guide, it's better to move all subpackages into the new nomos_specs directory, so that they can be imported by from nomos_specs.mixnet.config import MixnetConfig. But, I didn't change the directory structure in this PR for now to make changes simpler. I think it's not bad to do from mixnet.... because we are not publishing this to PyPI. Later, we can reorganize the directory structure if needed.

nomos-specs/
    pyproject.toml
    nomos_specs/
        __init__.py
        mixnet/
            __init__.py
            some_module.py
        cryptarchia/
            __init__.py
            some_module.py
        da/
            __init__.py
            some_module.py
        ...

[youngjoon-lee]

If we use the SSH URL instead of https, it's failed to run the git submodule update ... in some environment. For example, the Github Action of the nomos-simulations runs the pip install ..., which clones this repo and update submodules. In that environment, the error Permission denied occurs. There might be some solutions but I think it's simpler to use the HTTPS URL here.

[youngjoon-lee]

Closing this. Instead I will define whatever necessary in the nomos-simulation, even if similar code is already in this repo. That’s better to define and update codes separately according to the needs of simulations, for quick iterations. Simulations may require more variants of implementations to compare them with each other. After having a clear insight from the simulations and determining the optimal options, we can move some of them into this repo as a spec.