reorganize to prepare for publish

This commit is contained in:
Soren I. Bjornstad 2021-09-21 11:32:33 -05:00
parent 87438e5858
commit ea7f7edf91
11 changed files with 23031 additions and 10 deletions

2
.gitignore vendored
View File

@ -2,6 +2,6 @@ __pycache__/
.vscode/ .vscode/
venv/ venv/
*.egg-info/ *.egg-info/
docs/_build/ cli_docs/_build/
tzk/editions/ tzk/editions/
dist/ dist/

28
README.md Normal file
View File

@ -0,0 +1,28 @@
**tzk** (*TiddlyZettelKasten*)
is a TiddlyWiki edition and associated CLI
for maintaining personal notes
in something approaching the Zettelkasten method.
Its updated periodically from whatever tooling Im currently using
[in my own Zettelkasten](https://zettelkasten.sorenbjornstad.com).
As such, its currently considered alpha-quality;
while it ought to be very stable and theres no meaningful risk of data loss,
updating to a newer version might be difficult
and Im unlikely to accept patches
unless theyre something I want in my own Zettelkasten.
This is intended primarily as a nice starting platform
on which to build your own tooling.
Some basic knowledge of [TiddlyWiki](https://tiddlywiki.com)
is necessary and assumed.
Documentation / Installation
============================
Find a live version of the edition on the web with further instructions
at https://sobjornstad.github.io/tzk.
You can find the documentation for the CLI
(which handles creating the wiki,
versioning with Git,
and creating public and other derivative versions of the wiki)
at https://readthedocs.org/projects/tzk/.

View File

@ -18,9 +18,9 @@ copyright = '2021 Soren Bjornstad'
author = 'Soren Bjornstad' author = 'Soren Bjornstad'
# The short X.Y version # The short X.Y version
version = "0.0.1" version = "0.1.0"
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = "0.0.1" release = "0.1.0"
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------

22991
docs/index.html Normal file

File diff suppressed because one or more lines are too long

View File

@ -4,27 +4,29 @@ setup.py - setuptools configuration for esc
import setuptools import setuptools
#with open("README.md", "r") as fh: with open("README.md", "r") as fh:
# long_description = fh.read() long_description = fh.read()
long_description = "my nice long *description*"
setuptools.setup( setuptools.setup(
name="tzk", name="tzk",
version="0.0.1", version="0.1.0",
author="Soren I. Bjornstad", author="Soren I. Bjornstad",
author_email="contact@sorenbjornstad.com", author_email="zettelkasten@sorenbjornstad.com",
description="Build tool for TiddlyWiki Zettelkasten", description="Build tool for TiddlyWiki Zettelkasten",
long_description=long_description, long_description=long_description,
long_description_content_type="text/markdown", long_description_content_type="text/markdown",
url="TODO", url="https://github.com/sobjornstad/tzk",
packages=setuptools.find_packages(), packages=setuptools.find_packages(),
classifiers=[ classifiers=[
"Development Status :: 3 - Alpha",
"Environment :: Console",
"Natural Language :: English",
"Programming Language :: Python :: 3", "Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.9",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "License :: OSI Approved :: MIT License",
"Operating System :: OS Independent", "Operating System :: OS Independent",
], ],
entry_points={ entry_points={