Skip to content

Commit

Permalink
Merge pull request #36 from NovelaNeuro/user/wmerynda/ndx_relaease_0.…
Browse files Browse the repository at this point in the history
…1.004

release 0.0.004
  • Loading branch information
MarcinAtNovela authored May 27, 2020
2 parents a5df5f1 + cf16dc6 commit 79ee140
Show file tree
Hide file tree
Showing 20 changed files with 58 additions and 58 deletions.
46 changes: 23 additions & 23 deletions NEXTSTEPS.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Next Steps for ndx-fl-novela Extension for NWB:N
# Next Steps for ndx-franklab-novela Extension for NWB:N

## Creating Your Extension

1. In a terminal, change directory into the new ndx-fl-novela directory.
1. In a terminal, change directory into the new ndx-franklab-novela directory.

2. Add any packages required by your extension to `requirements.txt` and `setup.py`.

Expand All @@ -14,15 +14,15 @@ and any other packages required by your extension.
- If you want to create any custom classes for interacting with the extension,
add them to the `src/pynwb`.
- If present, the `src/pynwb` folder MUST contain the following:
- `ndx-fl-novela` - Folder with the sources of the NWB extension
- `ndx-fl-novela/__init__.py` - Python file that may be empty
- `ndx-franklab-novela` - Folder with the sources of the NWB extension
- `ndx-franklab-novela/__init__.py` - Python file that may be empty
- If present, the `src/pynwb` folder MAY contain the following files/folders:
- `test` - Folder for unit tests for the extensions
- `jupyter_widgets` - Optional package with custom widgets for use with Jupyter

5. Run `python src/spec/create_extension_spec.py` to generate the
`spec/ndx-fl-novela.namespace.yaml` and
`spec/ndx-fl-novela.extensions.yaml` files.
`spec/ndx-franklab-novela.namespace.yaml` and
`spec/ndx-franklab-novela.extensions.yaml` files.

6. You may need to modify `setup.py` and re-run `python setup.py install` if you
use any dependencies.
Expand All @@ -32,7 +32,7 @@ use any dependencies.

1. Install the latest release of hdmf_docutils: `python -m pip install hdmf-docutils`

2. Start a git repository for your extension directory ndx-fl-novela
2. Start a git repository for your extension directory ndx-franklab-novela
and push it to GitHub. You will need a GitHub account.
- Follow these directions:
https://help.github.com/en/articles/adding-an-existing-project-to-github-using-the-command-line
Expand All @@ -48,12 +48,12 @@ your extension.

7. Add a license file. Permissive licenses should be used if possible. **A [BSD license](https://opensource.org/licenses/BSD-3-Clause) is recommended.**

8. Make a release for the extension on GitHub with the version number specified. e.g. if version is 0.1.0, then this page should exist: https://github.com/NovelaDevops/ndx-fl-novela/releases/tag/0.1.0 . For instructions on how to make a release on GitHub see [here](https://help.github.com/en/github/administering-a-repository/creating-releases).
8. Make a release for the extension on GitHub with the version number specified. e.g. if version is 0.1.0, then this page should exist: https://github.com/NovelaDevops/ndx-franklab-novela/releases/tag/0.1.0 . For instructions on how to make a release on GitHub see [here](https://help.github.com/en/github/administering-a-repository/creating-releases).

9. Publish your updated extension on PyPi.
- Follow these directions: https://packaging.python.org/tutorials/packaging-projects/
- You may need to modify `setup.py`
- If your extension version is 0.1.0, then this page should exist: https://pypi.org/project/ndx-fl-novela/0.1.0
- If your extension version is 0.1.0, then this page should exist: https://pypi.org/project/ndx-franklab-novela/0.1.0

Once your GitHub release and ``setup.py`` are ready, publishing on PyPi:
```bash
Expand All @@ -67,13 +67,13 @@ repository.
11. Clone the fork onto your local filesystem.

12. Copy the directory `staged-extensions/example` to a new directory
`staged-extensions/ndx-fl-novela`:
`staged-extensions/ndx-franklab-novela`:

```bash
cp -r staged-extensions/example staged-extensions/ndx-fl-novela
cp -r staged-extensions/example staged-extensions/ndx-franklab-novela
```

13. Edit `staged-extensions/ndx-fl-novela/ndx-meta.yaml`
13. Edit `staged-extensions/ndx-franklab-novela/ndx-meta.yaml`
with information on where to find your NWB extension.
- The YAML file MUST contain a dict with the following keys:
- name: extension namespace name
Expand All @@ -87,28 +87,28 @@ with information on where to find your NWB extension.

You may copy and modify the following YAML that was auto-generated:
```yaml
name: ndx-fl-novela
name: ndx-franklab-novela
version: 0.0.5
src: https://github.com/NovelaDevops/ndx-fl-novela
pip: https://pypi.org/project/ndx-fl-novela/
src: https://github.com/NovelaDevops/ndx-franklab-novela
pip: https://pypi.org/project/ndx-franklab-novela/
license: BSD 3-Clause
maintainers:
- NovelaDevops
```

14. Edit `staged-extensions/ndx-fl-novela/README.md`
14. Edit `staged-extensions/ndx-franklab-novela/README.md`
to add information about your extension. You may copy it from
`ndx-fl-novela/README.md`.
`ndx-franklab-novela/README.md`.

```bash
cp ndx-fl-novela/README.md staged-extensions/ndx-fl-novela/README.md
cp ndx-franklab-novela/README.md staged-extensions/ndx-franklab-novela/README.md
```

15. Add and commit your changes to Git and push your changes to GitHub.
```
cd staged-extensions
git add ndx-fl-novela
git commit -m "Add new catalog entry for ndx-fl-novela" .
git add ndx-franklab-novela
git commit -m "Add new catalog entry for ndx-franklab-novela" .
git push
```
Expand All @@ -117,17 +117,17 @@ Mac, and Linux. The technical team will review your extension shortly after
and provide feedback and request changes, if any.
17. When your pull request is merged, a new repository, called
ndx-fl-novela-feedstock will be created in the nwb-extensions
ndx-franklab-novela-feedstock will be created in the nwb-extensions
GitHub organization and you will be added as a maintainer for that repository.
## Updating Your Published Extension
1. Update your ndx-fl-novela GitHub repository.
1. Update your ndx-franklab-novela GitHub repository.
2. Publish your updated extension on PyPi.
3. Fork the ndx-fl-novela-feedstock repository on GitHub.
3. Fork the ndx-franklab-novela-feedstock repository on GitHub.
4. Open a pull request to test the changes automatically. The technical team
will review your changes shortly after and provide feedback and request changes,
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ndx-fl-novela Extension for NWB
# ndx-franklab-novela Extension for NWB

# About
ndx-fl-novela is a python package containing NWB custom extensions.
ndx-franklab-novela is a python package containing NWB custom extensions.

# Extensions

Expand Down
2 changes: 1 addition & 1 deletion conda_upload.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/bin/bash

export PKG_NAME=ndx-fl-novela
export PKG_NAME=ndx-franklab-novela
export VERSION=$(python setup.py)
export ANACONDA_API_TOKEN=$CONDA_UPLOAD_TOKEN
export CONDA_BUILD_PATH=/home/travis/miniconda/envs/test-environment/conda-bld
Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@

# -- Project information -----------------------------------------------------

project = 'ndx-fl-novela'
project = 'ndx-franklab-novela'
copyright = '2020, NovelaDevops'
author = 'NovelaDevops'

# The short X.Y version
version = '0.0.003'
version = '0.0.004'

# The full version, including alpha/beta/rc tags
release = 'alpha'
Expand Down
4 changes: 2 additions & 2 deletions docs/source/conf_doc_autogen.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
spec_input_spec_dir = '..\spec'

# Name of the YAML file with the specification of the Namespace to be documented
spec_input_namespace_filename = 'ndx-fl-novela.namespace.yaml'
spec_input_namespace_filename = 'ndx-franklab-novela.namespace.yaml'

# Name of the default namespace in the file
spec_input_default_namespace = 'ndx-fl-novela'
spec_input_default_namespace = 'ndx-franklab-novela'


# -- Options for customizing the locations of output files
Expand Down
4 changes: 2 additions & 2 deletions docs/source/format.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

.. _ndx-fl-novela:
.. _ndx-franklab-novela:

********************
ndx-fl-novela
ndx-franklab-novela
********************

Version |release| |today|
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Specification for the ndx-fl-novela extension
Specification for the ndx-franklab-novela extension
==================================

.. toctree::
Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: ndx-fl-novela
name: ndx-franklab-novela
channels:
- conda-forge
- defaults
Expand Down
4 changes: 2 additions & 2 deletions meta.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{% set data = load_setup_py_data() %}

package:
name: ndx-fl-novela
name: ndx-franklab-novela
version: {{ data.get('version') }}

source:
git_url: https://github.com/NovelaNeuro/ndx-fl-novela
git_url: https://github.com/NovelaNeuro/ndx-franklab-novela

build:
number: 0
Expand Down
12 changes: 6 additions & 6 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# -*- coding: utf-8 -*-
version = "0.0.003"
version = "0.0.004"
print(version)

import os
Expand All @@ -23,7 +23,7 @@
readme = ""

setup_args = {
'name': 'ndx-fl-novela',
'name': 'ndx-franklab-novela',
'version': version,
'description': 'NovelaNeurotechnologies Namespaces',
'long_description': readme,
Expand All @@ -39,8 +39,8 @@
'packages': find_packages('src/pynwb'),
'package_dir': {'': 'src/pynwb'},
'package_data': {'ndx_fl_novela': [
'spec/ndx-fl-novela.namespace.yaml',
'spec/ndx-fl-novela.extensions.yaml',
'spec/ndx-franklab-novela.namespace.yaml',
'spec/ndx-franklab-novela.extensions.yaml',
]},
'classifiers': [
"Intended Audience :: Developers",
Expand All @@ -51,8 +51,8 @@


def _copy_spec_files(project_dir):
ns_path = os.path.join(project_dir, 'spec', 'ndx-fl-novela.namespace.yaml')
ext_path = os.path.join(project_dir, 'spec', 'ndx-fl-novela.extensions.yaml')
ns_path = os.path.join(project_dir, 'spec', 'ndx-franklab-novela.namespace.yaml')
ext_path = os.path.join(project_dir, 'spec', 'ndx-franklab-novela.extensions.yaml')
dst_dir = os.path.join(project_dir, 'src', 'pynwb', 'ndx_fl_novela', 'spec')

if not os.path.exists(dst_dir):
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ namespaces:
contact:
- [email protected]
doc: NovelaNeurotechnologies Namespaces
name: ndx-fl-novela
name: ndx-franklab-novela
schema:
- namespace: core
neurodata_types:
- ElectrodeGroup
- Device
- NWBDataInterface
- source: ndx-fl-novela.extensions.yaml
version: 0.0.002
- source: ndx-franklab-novela.extensions.yaml
version: 0.0.004
4 changes: 2 additions & 2 deletions src/pynwb/ndx_fl_novela/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
ndx_fl_novela_specpath = os.path.join(
os.path.dirname(__file__),
'spec',
'ndx-fl-novela.namespace.yaml'
'ndx-franklab-novela.namespace.yaml'
)

# If the extension has not been installed yet but we are running directly from
Expand All @@ -16,7 +16,7 @@
os.path.dirname(__file__),
'..', '..', '..',
'spec',
'ndx-fl-novela.namespace.yaml'
'ndx-franklab-novela.namespace.yaml'
))

# Load the namespace
Expand Down
2 changes: 1 addition & 1 deletion src/pynwb/ndx_fl_novela/associated_files.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from pynwb.core import NWBDataInterface


@register_class('AssociatedFiles', 'ndx-fl-novela')
@register_class('AssociatedFiles', 'ndx-franklab-novela')
class AssociatedFiles(NWBDataInterface):
""" Representation of associated files in NWB """
__nwbfields__ = ('description', 'content')
Expand Down
2 changes: 1 addition & 1 deletion src/pynwb/ndx_fl_novela/header_device.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
from pynwb.device import Device


@register_class('HeaderDevice', 'ndx-fl-novela')
@register_class('HeaderDevice', 'ndx-franklab-novela')
class HeaderDevice(Device):
"""Configuration comes from SpikeGadgets recording system. Represented as HeaderDevice in NWB"""
__nwbfields__ = ('headstage_serial', 'headstage_smart_ref_on', 'realtime_mode', 'headstage_auto_settle_on',
Expand Down
2 changes: 1 addition & 1 deletion src/pynwb/ndx_fl_novela/nwb_electrode_group.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from pynwb.ecephys import ElectrodeGroup


@register_class('NwbElectrodeGroup', 'ndx-fl-novela')
@register_class('NwbElectrodeGroup', 'ndx-franklab-novela')
class NwbElectrodeGroup(ElectrodeGroup):
''' Representation of custom ElectrodeGroup object in NWB '''

Expand Down
6 changes: 3 additions & 3 deletions src/pynwb/ndx_fl_novela/probe.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from pynwb.device import Device


@register_class('ShanksElectrode', 'ndx-fl-novela')
@register_class('ShanksElectrode', 'ndx-franklab-novela')
class ShanksElectrode(NWBContainer):
''' Representation of ShanksElectrode object in NWB '''

Expand All @@ -21,7 +21,7 @@ def __init__(self, **kwargs):
self.rel_z = kwargs['rel_z']


@register_class('Shank', 'ndx-fl-novela')
@register_class('Shank', 'ndx-franklab-novela')
class Shank(MultiContainerInterface):
''' Representation of Shank object in NWB '''

Expand All @@ -43,7 +43,7 @@ def __init__(self, **kwargs):
]


@register_class('Probe', 'ndx-fl-novela')
@register_class('Probe', 'ndx-franklab-novela')
class Probe(Device, MultiContainerInterface):
''' Representation of Probe object in NWB '''

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ namespaces:
contact:
- [email protected]
doc: NovelaNeurotechnologies Namespaces
name: ndx-fl-novela
name: ndx-franklab-novela
schema:
- namespace: core
neurodata_types:
- ElectrodeGroup
- Device
- NWBDataInterface
- source: ndx-fl-novela.extensions.yaml
version: 0.0.002
- source: ndx-franklab-novela.extensions.yaml
version: 0.0.004
4 changes: 2 additions & 2 deletions src/spec/create_extension_spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ def main():
# these arguments were auto-generated from your cookiecutter inputs
ns_builder = NWBNamespaceBuilder(
doc="""NovelaNeurotechnologies Namespaces""",
name="""ndx-fl-novela""",
version="""0.0.003""",
name="""ndx-franklab-novela""",
version="""0.0.004""",
author=list(map(str.strip, """NovelaDevops""".split(','))),
contact=list(map(str.strip, """[email protected]""".split(',')))
)
Expand Down

0 comments on commit 79ee140

Please sign in to comment.