Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the properties that all SymbiFlow provided Python modules should include. #2

Open
mithro opened this issue Aug 11, 2021 · 6 comments

Comments

@mithro
Copy link
Member

mithro commented Aug 11, 2021

SymbiFlow has a lot of Python projects. We want all our Python projects to behave in the same way and feel the same.

Python has a lot of gotcha's around publishing good packages, tracking dependencies and making sure they work.

First step to doing this is documenting how we expect things to behave.

@mithro
Copy link
Member Author

mithro commented Aug 11, 2021

I started a Google Doc where I was trying to document how I thought Python modules should work.

@mithro
Copy link
Member Author

mithro commented Aug 11, 2021

See also things like https://github.com/SymbiFlow/fasm/pull/64/checks?check_run_id=2055039242#step:8:3258

GitHub
setup_requires needs to be specified in both setup.py and pyproject.toml. The requirements.txt file should use -e . to install the module (and thus get the requirements). If a local or non-PyPi ver...

@mithro
Copy link
Member Author

mithro commented Aug 11, 2021

https://docs.google.com/document/d/1AaL460Uf_8_9v8EIy4pAZYTFOFXbv5O4RRU7Jv4t_Z4/edit#heading=h.eods90sxr89u

Google Docs
Conda Notes Key Relationships General Conda Process Installing Starting Restarting Installing Packages Environment Files Windows Notes Auto Install? In what folder should I install Anaconda on Windows? Further Info Key This is a file This is a command This is python code Relationships nodej...

@mithro
Copy link
Member Author

mithro commented Aug 11, 2021

https://docs.google.com/document/d/10_MqFjTIYVVuOJlusJydsp4KOcmrrHk03__7ME5thOI/edit

Google Docs
PARENT: http://bit.ly/unai-eda-megadoc Building, packaging and installing�Open Source EDA tooling�for mixed HDL designs Packaging + Distribution Systems 1 Overall Goals 2 Distribution: Canonical package managers (apk, apt, dnf, pacman, etc.) 2 Alpine Linux 3 Android 3 Arch Linux 3 Debian/Ubunt...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant