Science Score: 36.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
6 of 61 committers (9.8%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (19.8%) to scientific vocabulary
Keywords
Keywords from Contributors
Repository
Create delightful software with Jupyter Notebooks
Basic Info
- Host: GitHub
- Owner: AnswerDotAI
- License: apache-2.0
- Language: Jupyter Notebook
- Default Branch: main
- Homepage: https://nbdev.fast.ai/
- Size: 15.9 MB
Statistics
- Stars: 5,172
- Watchers: 50
- Forks: 510
- Open Issues: 176
- Releases: 53
Topics
Metadata Files
README.md
Getting Started
nbdev is a notebook-driven development platform. Simply write
notebooks with lightweight markup and get high-quality documentation,
tests, continuous integration, and packaging for free!
nbdev makes debugging and refactoring your code much easier than in
traditional programming environments since you always have live objects
at your fingertips. nbdev also promotes software engineering best
practices because tests and documentation are first class.
- Documentation is automatically generated using
Quarto and hosted on GitHub
Pages. Docs support LaTeX, are searchable,
and are automatically hyperlinked (including out-of-the-box support
for many packages via
nbdev-index) - Publish packages to PyPI and conda as well as tools to simplify
package releases. Python best practices are automatically followed,
for example, only exported objects are included in
__all__ - Two-way sync between notebooks and plaintext source code allowing you to use your IDE for code navigation or quick edits
- Tests written as ordinary notebook cells are run in parallel with a single command
- Continuous integration out-of-the-box with GitHub Actions that run your tests and rebuild your docs
- Git-friendly notebooks with Jupyter/Git hooks that clean unwanted metadata and render merge conflicts in a human-readable format
- … and much more!
Install
nbdev works on macOS, Linux, and most Unix-style operating systems. It works on Windows under WSL, but not under cmd or Powershell.
You can install nbdev with pip:
sh
pip install nbdev
… or with conda (or mamba):
sh
conda install -c fastai nbdev
Note that nbdev must be installed into the same Python environment
that you use for both Jupyter and your project.
How to use nbdev
The best way to learn how to use nbdev is to complete either the written walkthrough or video walkthrough:
Alternatively, there’s a shortened version of the video
walkthrough with coding sections sped up
using the unsilence Python library – it’s 27 minutes faster, but a bit
harder to follow.
You can also run nbdev_help from the terminal to see the full list of
available commands:
python
!nbdev_help
nbdev_bump_version Increment version in settings.ini by one
nbdev_changelog Create a CHANGELOG.md file from closed and labeled GitHub issues
nbdev_clean Clean all notebooks in `fname` to avoid merge conflicts
nbdev_conda Create a `meta.yaml` file ready to be built into a package, and optionally build and upload it
nbdev_create_config Create a config file.
nbdev_docs Create Quarto docs and README.md
nbdev_export Export notebooks in `path` to Python modules
nbdev_filter A notebook filter for Quarto
nbdev_fix Create working notebook from conflicted notebook `nbname`
nbdev_help Show help for all console scripts
nbdev_install Install Quarto and the current library
nbdev_install_hooks Install Jupyter and git hooks to automatically clean, trust, and fix merge conflicts in notebooks
nbdev_install_quarto Install latest Quarto on macOS or Linux, prints instructions for Windows
nbdev_merge Git merge driver for notebooks
nbdev_migrate Convert all markdown and notebook files in `path` from v1 to v2
nbdev_new Create an nbdev project.
nbdev_prepare Export, test, and clean notebooks, and render README if needed
nbdev_preview Preview docs locally
nbdev_proc_nbs Process notebooks in `path` for docs rendering
nbdev_pypi Create and upload Python package to PyPI
nbdev_readme Create README.md from readme_nb (index.ipynb by default)
nbdev_release_both Release both conda and PyPI packages
nbdev_release_gh Calls `nbdev_changelog`, lets you edit the result, then pushes to git and calls `nbdev_release_git`
nbdev_release_git Tag and create a release in GitHub for the current version
nbdev_requirements Writes a `requirements.txt` file to `directory` based on settings.ini.
nbdev_sidebar Create sidebar.yml
nbdev_test Test in parallel notebooks matching `path`, passing along `flags`
nbdev_trust Trust notebooks matching `fname`
nbdev_update Propagate change in modules matching `fname` to notebooks that created them
nbdev_update_license Allows you to update the license of your project.
FAQ
Q: What is the warning “Found a cell containing mix of imports and computations. Please use separate cells”?
A: You should not have cells that are not exported, and contain a mix
of import statements along with other code. For instance, don’t do
this in a single cell:
python
import some_module
some_module.something()
Instead, split this into two cells, one which does import some_module,
and the other which does some_module.something().
The reason for this is that when we create your documentation website,
we ensure that all of the signatures for functions you document are up
to date, by running the imports, exported cells, and
show_doc functions
in your notebooks. When you mix imports with other code, that other code
will be run too, which can cause errors (or at least slowdowns) when
creating your website.
Q: Why is nbdev asking for root access? How do I install Quarto without root access?
A: When you setup your first project, nbdev will attempt to automatically download and install Quarto for you. This is the program that we use to create your documentation website.
Quarto’s standard installation process requires root access, and nbdev will therefore ask for your root password during installation. For most people, this will work fine and everything will be handled automatically – if so, you can skip over the rest of this section, which talks about installing without root access.
If you need to install Quarto without root access on Linux, first cd
to wherever you want to store it, then download
Quarto, and type:
bash
dpkg -x quarto*.deb .
mv opt/quarto ./
rmdir opt
mkdir -p ~/.local/bin
ln -s "$(pwd)"/quarto/bin/quarto ~/.local/bin
To use this non-root version of Quarto, you’ll need ~/.local/bin in
your PATH environment
variable.
(Alternatively, change the ln -s step to place the symlink somewhere
else in your path.)
Q: Someone told me not to use notebooks for “serious” software development!
A: Watch this video. Don’t worry, we
still get this too, despite having used nbdev for a wide range of
“very serious” software projects over the last three years, including
deep learning libraries, API
clients, Python language
extensions, terminal user
interfaces, and more!
Contributing
If you want to contribute to nbdev, be sure to review the
contributions
guidelines.
This project adheres to fastai’s code of
conduct.
By participating, you are expected to uphold this code. In general, we
strive to abide by generally accepted best practices in open-source
software development.
Make sure you have nbdev’s git hooks installed by running
nbdev_install_hooks
in the cloned repository.
Copyright
Copyright © 2019 onward fast.ai, Inc. Licensed under the Apache License, Version 2.0 (the “License”); you may not use this project’s files except in compliance with the License. A copy of the License is provided in the LICENSE file in this repository.
Owner
- Name: Answer.AI
- Login: AnswerDotAI
- Kind: organization
- Website: https://www.answer.ai
- Repositories: 20
- Profile: https://github.com/AnswerDotAI
GitHub Events
Total
- Create event: 15
- Release event: 7
- Issues event: 40
- Watch event: 222
- Delete event: 7
- Issue comment event: 86
- Push event: 82
- Pull request review event: 10
- Pull request review comment event: 16
- Pull request event: 42
- Fork event: 28
Last Year
- Create event: 15
- Release event: 7
- Issues event: 40
- Watch event: 222
- Delete event: 7
- Issue comment event: 86
- Push event: 82
- Pull request review event: 10
- Pull request review comment event: 16
- Pull request event: 42
- Fork event: 28
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Jeremy Howard | j@f****i | 641 |
| hamelsmu | h****n@g****m | 529 |
| seem | m****t@g****m | 148 |
| deven367 | m****n@g****m | 19 |
| Isaac Flath | I****h@g****m | 17 |
| David Leen | d****n@n****m | 15 |
| muellerzr | m****r@g****m | 11 |
| ncoop57 | nc@a****i | 8 |
| Kevin Bird | k****5@g****m | 7 |
| Alexey Zaytsev | a****v@g****m | 7 |
| Tim Huegerich | h****m@g****m | 6 |
| restlessronin | 8****n | 6 |
| Radek Osmulski | r****i@g****m | 6 |
| David Micallef | d****f@t****m | 6 |
| Michael Aye | k****e@g****m | 4 |
| dsm-72 | s****r@y****u | 4 |
| omlnaut | o****l@g****m | 4 |
| benoit-cty | 6****y | 3 |
| slee5777 | 2****7 | 3 |
| ncoop57 | n****1@e****u | 3 |
| Benjamin Clavié | b****n@c****u | 3 |
| Dien-Hoa | d****a@s****m | 3 |
| Eugene Wolfson | e****n@g****m | 3 |
| Fabian | f****r@e****m | 3 |
| Nate Stanley | 2****y | 3 |
| Rens | r****l@g****m | 3 |
| Simone Massaro | s****o@m****t | 3 |
| Bhargav Kowshik | b****k@g****m | 2 |
| Marcus Gawronsky | m****g@m****a | 2 |
| K.-Michael Aye | a****e@e****u | 2 |
| and 31 more... | ||
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 54
- Total pull requests: 84
- Average time to close issues: 3 months
- Average time to close pull requests: 3 months
- Total issue authors: 42
- Total pull request authors: 35
- Average comments per issue: 1.67
- Average comments per pull request: 2.2
- Merged pull requests: 50
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 39
- Pull requests: 57
- Average time to close issues: 18 days
- Average time to close pull requests: 7 days
- Issue authors: 30
- Pull request authors: 18
- Average comments per issue: 0.82
- Average comments per pull request: 1.81
- Merged pull requests: 33
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jph00 (9)
- 2catycm (3)
- jlopezpena (2)
- idahlke-blacksky (2)
- matdmiller (1)
- nicomarr (1)
- mattgra (1)
- michela (1)
- andruum (1)
- Rajon010 (1)
- bamford (1)
- ADubinA (1)
- progressEdd (1)
- abdulahad (1)
- Sciemon (1)
Pull Request Authors
- hamelsmu (10)
- ncoop57 (8)
- Isaac-Flath (6)
- deven367 (5)
- RensDimmendaal (4)
- radekosmulski (4)
- ozpau (4)
- jbwhit (2)
- benoit-cty (2)
- lukastk (2)
- dsm-72 (2)
- kurianbenoy-sarvam (2)
- alex-rozenshteyn-leapyear (2)
- n-e-w (2)
- michaelaye (2)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 119,595 last-month
- Total docker downloads: 1,786
-
Total dependent packages: 126
(may contain duplicates) -
Total dependent repositories: 801
(may contain duplicates) - Total versions: 191
- Total maintainers: 2
pypi.org: nbdev
Create delightful software with Jupyter Notebooks
- Homepage: https://github.com/AnswerDotAI/nbdev
- Documentation: https://nbdev.fast.ai/
- License: Apache Software License 2.0
-
Latest release: 2.4.5
published 7 months ago
Rankings
Maintainers (1)
pypi.org: nbdev-simonkeys
Create delightful software with Jupyter Notebooks
- Homepage: https://github.com/AnswerDotAI/nbdev
- Documentation: https://nbdev.fast.ai/
- License: Apache Software License 2.0
-
Latest release: 2.3.35
published about 1 year ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v3 composite
- peaceiris/actions-gh-pages v3 composite
- fastai/workflows/quarto-ghp master composite
- fastai/workflows/nbdev-ci master composite