Add initial skeleton files - #1
Conversation
This commit adds the inital skeleton files needed for a bare-bones python library. Includes a simple configure script and setup.py file Signed-off-by: Steven Esser <sesser@nexb.com>
|
This a is simple base to get started with breaking out various python libraries. We can keep this updated as we develop a concrete set of conventions. Following this as a guide: https://blog.jaraco.com/a-project-skeleton-for-python-projects/ we will be able to update our already existing repos + all new repos with this skeleton structure. |
JonoYang
left a comment
JonoYang
left a comment
There was a problem hiding this comment.
lgtm. The only change I can think of is to add pytest-xdist to requirements-tests.txt just so we can run multiple tests at once, but that is minor.
Signed-off-by: Steven Esser <sesser@nexb.com>
* Add AUTHORS.rst * Add CHANGELOG.rst * Add setup.cfg Signed-off-by: Steven Esser <sesser@nexb.com>
* Add PEP 517/518 pyproject.toml file * Add setuptools_scm to handle versioning * Add setup.py content to setup.cfg * Update setup.py to act as a shim (so pip install -e works) Addresses: #2 Signed-off-by: Steven Esser <sesser@nexb.com>
Signed-off-by: Steven Esser <sesser@nexb.com>
JonoYang
left a comment
JonoYang
left a comment
There was a problem hiding this comment.
I am able to merge in the changes into plugincode, run the configure script, and make a wheel. I noticed that the version number of the wheel was 0.1.dev102+gc6396ae.d20200925. Can I set the version number to start from 20.09 in setup.cfg?
|
@JonoYang The version is now based of the git tag at the time of wheel creation. Try checking out to |
|
@JonoYang Actually, you will need to create a v20.09 tag first, and it should work (there are no tags right now in plugincode) See https://github.com/pypa/setuptools_scm#default-versioning-scheme for more details. |
pombredanne
left a comment
pombredanne
left a comment
There was a problem hiding this comment.
Looking good! See a comment inline.
| @@ -0,0 +1,5 @@ | |||
| Release notes | |||
| ------------- | |||
| ### Version 0.0.0 | |||
There was a problem hiding this comment.
What's the best way to generate this? I wonder if adopting towncrier would be a good thing?
There was a problem hiding this comment.
#9 opened for this. This will require a bit more work, so I will do that in a different PR/branch
Signed-off-by: Steven Esser <sesser@nexb.com>
Signed-off-by: Steven Esser <sesser@nexb.com>
fcf8789 to
343ff29
Compare
Signed-off-by: Steven Esser <sesser@nexb.com>
Signed-off-by: Steven Esser <sesser@nexb.com>
3 participants
This commit adds the inital skeleton files needed for a bare-bones
python library. Includes a simple configure script and setup.py file
Signed-off-by: Steven Esser sesser@nexb.com