feature/logo #143
feature/logo #143
Conversation
README.md
Outdated
| handle = sigmf.sigmffile.fromfile('example.sigmf') | ||
| handle.read_samples() # returns timeseries data | ||
| handle.get_global_info() # returns 'global' metadata dictionary | ||
| handle.get_captures() # returns 'captures' metadata dictionary |
There was a problem hiding this comment.
Minor note: get_captures:
# returns list of 'captures' dictionaries
|
Sure looking forward to this getting merged! |
|
Fixed @jacobagilbert's minor issue by updating the other PR #138 and rebasing this. |
|
@bhilburn Is this ready to merge then?? |
|
@Teque5 - Actually, I just realized the comment I left in #117 is wrong - I should /not/ touch the README, because it'll just create new conflicts with this PR, hah. Do you want to update this PR with the final path? It's here: |
|
Okay this branch is now ready to merge after #138. I updated the link in the README.md. |
|
@bhilburn I think you may have to grant me edit access on the wiki. |
|
Merged. @Teque5 - just added you to a team to try and give you wiki write access. Give it a go |
@bhilburn
Features
sigmflogo & pngexample_metadata.pyThis PR includes the SigMF logo as discussed in #117 but should be modified to replace "(@bhilbern insert)" in the provided
logo/README.mdwith the path to the final zip archive.This PR only has one commit but branches from PR #138, so that should be merged first.
Option
One option I'll mention - I was considering making it so the logo would be installed with the
pippackage (when future users dopip install sigmf. This is easily possible but means that thesigmffiles must live in a subfolder of the package to be installed. I wasn't sure if we wanted to do this. We could potentially use it for tests or examples out-of-the-box if we go that direction. It would mean our distributable would go from 19KB to 1.2MB.¯\_(ツ)_/¯Note to self to implement the
pipdistributed logo:sigmffiles to a folder inside the module'logo': ['*.sigmf*'],topackage_datainsidesetup.py