Giters

bids-standard / pybv

A lightweight I/O utility for the BrainVision data format, written in Python.

Home Page:https://pybv.readthedocs.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

pip PyBV --> pybv

sappelhoff opened this issue · comments

commented

The current pip package PyBV should be renamed to pybv according to pep8 convention and to be consistent with pyedf, see: bids-standard/pyedf#5

Also, the contents of this repo and the PyBV package are not congruent, this is something to be solved soonish in order to avoid confusion.

  • remove install_requires from setup.py, because it's easier if people install numpy themselves (more flexibility)
  • discuss licensing
  • set Maintainer and Maintainer Email
  • update .gitignore to exclude build and /dist
  • check how the rendering of README etc. works on test.pypi: https://test.pypi.org/project/pybv/
  • update version to 0.0.1
  • make a "release" on github
  • upload to pypi
  • add other contributors as maintainers
  • add pypi badge and pypi download stats badge (https://pepy.tech/)
  • deal with #3 by pip installing in the circleci config ... see #9
commented

totally agree - we should do this whenever we make a pip release for pybv...who controls the pip page for pyBV?

commented

Philip Alday :-)

commented

cc @palday - can you delete the pypi project so that we can re-upload with the name as pybv instead of pyBV? :-)

commented

deleted. It's in your hands now!

commented

thanks @palday!

@choldgraf, I have uploaded a test to test.pypi, see: https://test.pypi.org/project/pybv/

I have entered myself as the maintainer for now - if we do the real upload to pypi, should we create a shared bids-community account? Personally I would prefer if one of us takes the responsibility and hands over whenever a successor is needed and available.

edit: I just realized that we can have multiple owners and maintainers, so this is not a problem anymore :-) ... if you agree, I can upload pybv to pypi

one more edit: Regarding the licensing, I would be more comfortable to write the names of the authors instead of the generic "The BIDS Community", which I feel muddles both credit and responsibility. I like how it's done in MNE-Python, where in the general LICENSE file it says "MNE-Python authors" and then more specifically in the single modules, you add yourself by name to the license preamble, if you contribute to the code. See:

What do you think about that?

commented

@sappelhoff that works for me! Agree that it's good to keep things explicit, so long as it's clear that the tool is technically "owned" by the community, and that any specific maintainer has the right to step away from core maintenance privileges!