OzCore

OzCore is my core.

PyPI version Documentation Status HitCount

It is automating my boring stuff. A time saver for me. I can access frequently used modules and methods easliy. Most of my time is passing with Jupyter Notebooks, and OzCore is my best friend.

Many code snippets derive from a hard processes. I search for the best fitting options and try them sometimes for hours or days. OzCore keeps my good practices as side notes. My quality time for coding is mostly passing with annoying dev-environment, re-setups and glitches. OzCore skips the hard process and provides me with a fresh working environment, where All necessary packages installed.

Goals

  • a Jupyter Notebook having the most used modules.

  • shorthand to

    • path operations

    • tmp folder actions

    • Sqlite operations

    • CSV operations

    • Dataframe operations

    • Dummy records

    • Jupyter initial setups

    • Jupyter Notebook grid plugins

    • and some MS Office automations

Warnings

Work In Progress

This package is continuously WIP. It is for my development projects and I happily share it with open source developers. But, please bear with the versions and tests, which may effect your applications.

Massive Dependencies

Since OzCore is a collection of snippets using diverse packages, massive amount of dependencies will be downloaded.

Warning

Please see dependencies in pyproject.toml before installing.

MacOS bound modules

Some of the helper modules and functions are directly referenced to MacOS environment. Espacially Windows users may not like it. And some references are pointing to options which may not be available in your system. Such as OneDrive folder or gDrive folder. I have tests to distinguish between users, nevertheless you should be aware of this.

Installation

I would prefer to run on an Anaconda environment. Here you will find multiple examples.

Warning

Python environment management has become a disaster. Please be sure where you are with which python .

I. Anaconda

You may want to set the global Python version with Pyenv as pyenv global 3.8.3 (of course if pyenv is available.)

# create new env
conda create -n py383

conda activate py383

# this initiates every source bindings to new env
conda install pip

# install ozcore
conda install ozcore

II. Virtualenv

# create a virtualenv
python -m venv .venv

source .venv/bin/activate

pip install ozcore

III. Pip simple

# in any environment having pip
pip install ozcore

IV. Poetry with Pyenv

# in any package folder (3.8.4 version of python is arbitrary)
pyenv local 3.8.4

poetry shell

poetry add ozcore

V. GitHub with Pip

# in any environment having pip
pip install https://github.com/ozgurkalan/OzCore.git

VI. GitHub clone

# in some folder, e.g. Desktop
git clone https://github.com/ozgurkalan/OzCore.git

Jupyter Kernel

Jupyter has its own configuration. Espacially when you have Anaconda installed, kernel.json may have what conda sets.

For your Jupyter Notebook to run in your dedicated environment, please use the following script:

# add kernell to Jupyter
python -m ipykernel install --user --name=<your_env_name>

# remove the kernel from Jupyter
jupyter kernelspec uninstall <your_env_name>

Fresh installs may have problems with enabling extentions. You shall run the commands below to activate.

jupyter nbextension enable --py --sys-prefix qgrid
jupyter nbextension enable --py --sys-prefix widgetsnbextension

Jupyter Extensions

This step copies the nbextensions javascript and css files into the jupyter server’s search directory, and edits some jupyter config files.

jupyter contrib nbextension install --user

CHANGELOG

v1.1.11

  • Include unzip helper function

  • Add dependencies: pytest_httpserver, typer, tqdm

  • config and Makefile for pre-publish actions of the package

  • ozcore.__version__ is available

v1.1.10

Include seaborn in dependencies which pulled scipy as dependecy. Corrected installation on a conda environment in README.

v1.1.9

Include jupyter_contrib_nbextensions in dependencies. Update some of the docstrings. Include handcrafted requirements.txt in docs folder to meet ReadTheDocs build requirements.

v1.1.8

Reduce number of modules. Fit to ReadTheDocs requirements and include a requirements.txt derived from poetry.

v1.1.7

Rearrange and fix docs

v1.1.6

A stable version after experimenting PyPi automation with Github actions.

v1.0.1

Initial commit