Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Renamed the scaffold package to the bsb package #1

Merged
merged 11 commits into from
Jul 29, 2020
Merged

Conversation

Helveg
Copy link
Contributor

@Helveg Helveg commented Jul 29, 2020

Describe the work done

  • The setup now produces a wheel named bsb
  • The console_script entry point is renamed to bsb (so the command is bsb compile instead of scaffold compile)
  • The package source directory has been renamed to bsb
  • Imports should import the bsb module instead of the scaffold module.
  • Removed the obfuscation module. Since the package will go public we don't need to encrypt our public releases anymore.

Migration

Users (which we don't have) need to uninstall the dbbs-scaffold package and pip install bsb instead.

Developers need to run pip install -e . from the git repo root to register the new bsb command and change all from scaffold/ import scaffold statements to from bsb/import bsb

List which issues this resolves:

Closes #482

Tasks

  • Added tests
  • Updated documentation

@codecov-commenter
Copy link

codecov-commenter commented Jul 29, 2020

Codecov Report

Merging #1 into master will not change coverage.
The diff coverage is 92.30%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master       #1   +/-   ##
=======================================
  Coverage   49.11%   49.11%           
=======================================
  Files          63       63           
  Lines        7087     7087           
=======================================
  Hits         3481     3481           
  Misses       3606     3606           
Impacted Files Coverage Δ
bsb/__init__.py 100.00% <ø> (ø)
bsb/config.py 78.58% <ø> (ø)
bsb/connectivity/__init__.py 100.00% <ø> (ø)
bsb/connectivity/connectome/__init__.py 100.00% <ø> (ø)
bsb/connectivity/connectome/aa_purkinje.py 17.24% <ø> (ø)
bsb/connectivity/connectome/bcsc_purkinje.py 13.11% <ø> (ø)
bsb/connectivity/connectome/gap_junctions.py 14.49% <ø> (ø)
bsb/connectivity/connectome/glomerulus_golgi.py 25.71% <ø> (ø)
bsb/connectivity/connectome/glomerulus_granule.py 26.25% <ø> (ø)
bsb/connectivity/connectome/golgi_glomerulus.py 15.09% <ø> (ø)
... and 53 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update aa66213...b46322f. Read the comment docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants