Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rohanbatrain/second-brain-tools-2022
This is a repository holding tools for second brain project.
https://github.com/rohanbatrain/second-brain-tools-2022
cli obsidian-md obsidianmd pkm second-brain
Last synced: 14 days ago
JSON representation
This is a repository holding tools for second brain project.
- Host: GitHub
- URL: https://github.com/rohanbatrain/second-brain-tools-2022
- Owner: rohanbatrain
- License: other
- Created: 2022-11-16T13:04:26.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-30T04:49:29.000Z (8 months ago)
- Last Synced: 2024-10-30T17:07:45.560Z (15 days ago)
- Topics: cli, obsidian-md, obsidianmd, pkm, second-brain
- Language: Python
- Homepage:
- Size: 931 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Authors: AUTHORS.rst
Awesome Lists containing this project
- jimsghstars - rohanbatrain/second-brain-tools-2022 - This is a repository holding tools for second brain project. (Python)
README
# 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](https://rohanbatrain.github.io/second-brain-tools-2022/). 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](https://github.com/rohanbatrain/Second-Brain-Tools/actions/workflows/pylint.yml/badge.svg)](https://github.com/rohanbatrain/Second-Brain-Tools/actions/)
[![GitHub Actions Build Status](https://github.com/rohanbatrain/Second-Brain-Tools/actions/workflows/build.yml/badge.svg)](https://github.com/rohanbatrain/Second-Brain-Tools/actions/)
[![GitHub Actions Build Status](https://github.com/rohanbatrain/Second-Brain-Tools/actions/workflows/mkdocs.yml/badge.svg)](https://github.com/rohanbatrain/Second-Brain-Tools/actions/)
[![Coverage Status](https://codecov.io/gh/rohanbatrain/Second-Brain-Tools/branch/main/graphs/badge.svg?branch=main)](https://codecov.io/github/rohanbatrain/Second-Brain-Tools)
[![PyPI Package latest release](https://img.shields.io/pypi/v/second-brain-tools.svg)](https://pypi.org/project/second-brain-tools)
[![PyPI Wheel](https://img.shields.io/pypi/wheel/second-brain-tools.svg)](https://pypi.org/project/second-brain-tools)
[![Supported versions](https://img.shields.io/pypi/pyversions/second-brain-tools.svg)](https://pypi.org/project/second-brain-tools)
[![Supported implementations](https://img.shields.io/pypi/implementation/second-brain-tools.svg)](https://pypi.org/project/second-brain-tools)
[![Commits since latest release](https://img.shields.io/github/commits-since/rohanbatrain/Second-Brain-Tools/v0.0.4.svg)](https://github.com/rohanbatrain/Second-Brain-Tools/compare/v0.0.4...main)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
You can also install the in-development version with:
```bash
pip install https://github.com/rohanbatrain/Second-Brain-Tools/archive/main.zip
```# Documentation
To use the project:
```python
from second_brain_tools import cli
cli.main()
```Or from your terminal:
# Development
To run all the tests, run:
```bash
tox
```Note, to combine the coverage data from all the tox environments, run the following commands based on your operating system:
- Windows:
```bash
set PYTEST_ADDOPTS=--cov-append
tox
```- Other:
```bash
PYTEST_ADDOPTS=--cov-append tox
```