Metadata-Version: 2.4
Name: hopsa
Version: 0.3.1
Summary: Utilities that I use frequently
Author-email: Hopsakee <jdejong@posteo.nl>
License: Apache-2.0
Project-URL: Repository, https://github.com/Hopsakee/hopsa
Project-URL: Documentation, https://Hopsakee.github.io/hopsa
Keywords: nbdev,jupyter,notebook,python
Classifier: Natural Language :: English
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# hopsa


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

## Developer Guide

If you are new to using `nbdev` here are some useful pointers to get you
started.

# Install hopsa in Development mode

#### Using pip

Prefered method because `nbdev` assumes that you use `pip`.

``` sh
# make sure hop package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to hop
$ nbdev_prepare
```

#### Using uv

The package manager `uv` has many advantages over `pip`, but is not the
default for `nbdev`, so this approach might lead to some confusion.

Contrary to `pip`, `uv` installs the project in editable mode, such that
changes to the source code are immediately reflected in the environment.
`uv sync` and `uv run` both accept a `--no-editable` flag, which
instructs uv to install the project in non-editable mode.

``` sh
# make sure hop package is installed in development mode
$ uv sync

# make changes under nbs/ directory
# ...

# compile to have changes apply to hop
$ nbdev_prepare
```

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/Hopsakee/hop):

``` sh
$ pip install git+https://github.com/Hopsakee/hopsa.git
```

or with [uv](https://docs.astral.sh/uv/)

``` sh
$ uv add git+https://github.com/Hopsakee/hopsa.git
```

or from [pypi](https://pypi.org/project/hop/)

With pip

``` sh
$ pip install hopsa
```

or with [uv](https://docs.astral.sh/uv/)

``` sh
$ uv add hopsa
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/Hopsakee/hop)’s
[pages](https://Hopsakee.github.io/hop/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/Hopsakee/hop) and
[pypi](https://pypi.org/project/hop/) respectively.

## How to use

Fill me in please! Don’t forget code examples:

``` python
1+1
```

    2
