From ea7f7edf91a41c7c090298f599fe1f74ed1b70a7 Mon Sep 17 00:00:00 2001 From: "Soren I. Bjornstad" Date: Tue, 21 Sep 2021 11:32:33 -0500 Subject: [PATCH] reorganize to prepare for publish --- .gitignore | 2 +- README.md | 28 + {docs => cli_docs}/Makefile | 0 {docs => cli_docs}/_static/.gitkeep | 0 {docs => cli_docs}/builders.rst | 0 {docs => cli_docs}/conf.py | 4 +- {docs => cli_docs}/configuration.rst | 0 {docs => cli_docs}/index.rst | 0 {docs => cli_docs}/installation.rst | 0 docs/index.html | 22991 +++++++++++++++++++++++++ setup.py | 16 +- 11 files changed, 23031 insertions(+), 10 deletions(-) create mode 100644 README.md rename {docs => cli_docs}/Makefile (100%) rename {docs => cli_docs}/_static/.gitkeep (100%) rename {docs => cli_docs}/builders.rst (100%) rename {docs => cli_docs}/conf.py (98%) rename {docs => cli_docs}/configuration.rst (100%) rename {docs => cli_docs}/index.rst (100%) rename {docs => cli_docs}/installation.rst (100%) create mode 100644 docs/index.html diff --git a/.gitignore b/.gitignore index 148fcf2..0643d93 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,6 @@ __pycache__/ .vscode/ venv/ *.egg-info/ -docs/_build/ +cli_docs/_build/ tzk/editions/ dist/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..f2df1d5 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +**tzk** (*TiddlyZettelKasten*) + is a TiddlyWiki edition and associated CLI + for maintaining personal notes + in something approaching the Zettelkasten method. +It’s updated periodically from whatever tooling I’m currently using + [in my own Zettelkasten](https://zettelkasten.sorenbjornstad.com). +As such, it’s currently considered alpha-quality; + while it ought to be very stable and there’s no meaningful risk of data loss, + updating to a newer version might be difficult + and I’m unlikely to accept patches + unless they’re 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/. diff --git a/docs/Makefile b/cli_docs/Makefile similarity index 100% rename from docs/Makefile rename to cli_docs/Makefile diff --git a/docs/_static/.gitkeep b/cli_docs/_static/.gitkeep similarity index 100% rename from docs/_static/.gitkeep rename to cli_docs/_static/.gitkeep diff --git a/docs/builders.rst b/cli_docs/builders.rst similarity index 100% rename from docs/builders.rst rename to cli_docs/builders.rst diff --git a/docs/conf.py b/cli_docs/conf.py similarity index 98% rename from docs/conf.py rename to cli_docs/conf.py index 54920c1..1f20f77 100644 --- a/docs/conf.py +++ b/cli_docs/conf.py @@ -18,9 +18,9 @@ copyright = '2021 Soren Bjornstad' author = 'Soren Bjornstad' # The short X.Y version -version = "0.0.1" +version = "0.1.0" # The full version, including alpha/beta/rc tags -release = "0.0.1" +release = "0.1.0" # -- General configuration --------------------------------------------------- diff --git a/docs/configuration.rst b/cli_docs/configuration.rst similarity index 100% rename from docs/configuration.rst rename to cli_docs/configuration.rst diff --git a/docs/index.rst b/cli_docs/index.rst similarity index 100% rename from docs/index.rst rename to cli_docs/index.rst diff --git a/docs/installation.rst b/cli_docs/installation.rst similarity index 100% rename from docs/installation.rst rename to cli_docs/installation.rst diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 0000000..60b3ed2 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,22991 @@ + + + + + + + + + + + + + + + + + + + + +My TiddlyZettelKasten — Say something clever about it here + + + + + + + + + + + + +
+
+ Loading My TiddlyZettelKasten... +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + diff --git a/setup.py b/setup.py index 1084bd1..18ecb0d 100644 --- a/setup.py +++ b/setup.py @@ -4,27 +4,29 @@ setup.py - setuptools configuration for esc import setuptools -#with open("README.md", "r") as fh: -# long_description = fh.read() -long_description = "my nice long *description*" +with open("README.md", "r") as fh: + long_description = fh.read() setuptools.setup( name="tzk", - version="0.0.1", + version="0.1.0", author="Soren I. Bjornstad", - author_email="contact@sorenbjornstad.com", + author_email="zettelkasten@sorenbjornstad.com", description="Build tool for TiddlyWiki Zettelkasten", long_description=long_description, long_description_content_type="text/markdown", - url="TODO", + url="https://github.com/sobjornstad/tzk", packages=setuptools.find_packages(), classifiers=[ + "Development Status :: 3 - Alpha", + "Environment :: Console", + "Natural Language :: English", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", - "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", + "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ], entry_points={