Metadata-Version: 2.2
Name: snackademics
Version: 0.0.1
Summary: Learning in a fun and bite-sized way
Home-page: https://github.com/galopyz/snackademics
Author: Jay Suh
Author-email: shipalnomoo@gmail.com
License: Apache Software License 2.0
Keywords: nbdev jupyter notebook python
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastcore
Requires-Dist: bs4
Requires-Dist: html2text
Requires-Dist: httpx
Requires-Dist: lxml
Requires-Dist: claudette
Provides-Extra: dev
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# snackademics


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

Snackademics is a playful blend of “snacks” and “academics” - it
suggests learning in a fun, bite-sized way, rather than heavy academic
study. Like having a light snack instead of a full formal meal, but for
learning!

The name implies that you can approach learning in a casual, snackable
way while still getting the benefits of academic understanding. It’s
meant to make learning feel less intimidating and more enjoyable.

## Developer Guide

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

### Install snackademics in Development mode

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

# make changes under nbs/ directory
# ...

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

## Usage

### Installation

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

``` sh
$ pip install git+https://github.com/galopyz/snackademics.git
```

or from [conda](https://anaconda.org/galopyz/snackademics)

``` sh
$ conda install -c galopyz snackademics
```

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

``` sh
$ pip install snackademics
```

### Documentation

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

## How to use

Coming soon..
