search

dvc94ch / pykicad

Library for working with KiCAD file formats
ISC License
64 stars 18 forks source link

Add versioneer #29

Closed hmaarrfk closed 4 years ago

hmaarrfk commented 4 years ago

Hey all,

Thanks for making this cool library.

We are currently stuck needing to install this from git since a release has been for a while.

Installing versioneer makes this 1 step closer to enabling 1 click releases by adding a tag on github.

I'll make the PR to setup travis as well seperately.

What versioneer allows is precise versions between releases based on git tags.

For example: If i add a tag 0.1.1 to 6eee9b405345b7c1d104c6daef5b63a347f6dafd

git tag -a 0.1.1 6eee9b405345b7c1d104c6daef5b63a347f6dafd

(I can't do the above to the main repo, so I had to add this tag locally).

Installing pykicad in dev mode makes it clear that:

In [1]: import pykicad                                                                                   
In [2]: pykicad.__version__                                                                              
Out[2]: '0.1.1+16.g8b56d67.dirty'
  1. My local branch is ahead of 0.1.1 by 16 commits
  2. My local branch has uncomitted changes.
  3. The hash of my local branch is g8b56d67

This makes it super useful when trying to create reproducible builds and sharing them with others.

Mark

hmaarrfk commented 4 years ago

Thanks for this. I took the liberty of pushing a tag for 0.1.1