https://github.com/mpacer/jupyter_config

App for working with jupyter configuration files.
https://github.com/mpacer/jupyter_config

Last synced: 17 days ago
JSON representation

App for working with jupyter configuration files.

• Host: GitHub
• URL: https://github.com/mpacer/jupyter_config
• Owner: mpacer
• License: mit
• Created: 2018-07-17T16:36:26.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-09-12T17:32:30.000Z (over 6 years ago)
• Last Synced: 2024-12-30T21:52:09.248Z (about 1 month ago)
• Language: Python
• Size: 44.9 KB
• Stars: 0
• Watchers: 0
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
In order to use this

    pip install jupyter_config

Which is then executed as

    jupyter config search "your_search_term"

on the command line to search for "`your_search_term`".

If you pass 

    jupyter config list

it will return the total list of configuration files that it found relative to

the directory that you are running the command from (not just the directories,

which you can find using `jupyter --paths` beneath `config:`).

## Developing on jupyter_config

If you want to work on this codebase we recommend that you first fork the repository on GitHub.

Then clone your repository locally. 

`cd` into that directory and create a new remote called **upstream** that you will point at

this repo.

```

git remote add upstream https://github.com/mpacer/jupyter_config

```

Then you can editably install this with development dependencies so that any changes you make

to the codebase get propagated to the rest of the system. Assuming you are still in the root

directory of this project, you can do this with: 

```

pip install -e .[dev]

```

To speed up the iteration cycle on developing in the library, you can run our tests locally.

To do so run: 

```

pytest --pyargs jupyter_config

```

## Releasing jupyter_config

Before you release, you should make sure to run `check-manifest` to ensure your `MANIFEST.in`

is up to date.

More detailed release instructions are en route per issue #1.