Skip to content

rohanbatrain/second-brain-tools-2022

Repository files navigation

2024

We are making minor upgrades to adapt this project for integration into my Semester-2 college assignment.

2023

July

The partial documentation to get you started is live here. No plans for making any further documentation or hotfixes for this project.

June

I am releasing a hotfix for the PyPI package, version 0.0.4. This update addresses a minor issue caused by a change in the naming scheme of GitHub repositories, which was preventing the package from building properly in all Python environments. Additionally, I would like to inform you that support for pypy37 has been discontinued.

I am currently addressing the challenges caused by the insufficient documentation and actively working on improving it.

EOL

The project has been flagged as EOL (End of Life) on December 2022. Moving forward to more simplistic approach for better automation and other changes. You can still use the structure but please dont expect more updates or support.

Overview

GitHub Actions Build Status GitHub Actions Build Status GitHub Actions Build Status Coverage Status PyPI Package latest release PyPI Wheel Supported versions Supported implementations Commits since latest release

This project is a toolset for Second Brain. It helps to quickly and efficiently create notes using Second Brain Vault.

  • Free software: Apache Software License 2.0

Prerequisites

  1. Make sure you have Python 3 and pip installed.
  2. Please install Git on your specific system in order to run this code.

Installation

Installing second-brain-tools

You can also install the in-development version with:

pip install https://github.com/rohanbatrain/Second-Brain-Tools/archive/main.zip

Documentation

To use the project:

from second_brain_tools import cli  
cli.main()

Or from your terminal:

Installing second-brain-tools

Development

To run all the tests, run:

tox

Note, to combine the coverage data from all the tox environments, run the following commands based on your operating system:

  • Windows:
set PYTEST_ADDOPTS=--cov-append
tox
  • Other:
PYTEST_ADDOPTS=--cov-append tox