Portable version of base24-builder-python for use in template repositories
Portable version of base24-builder-python
Thank you to https://github.com/InspectorMustache/base16-builder-python (MIT)
for the original base16-builder
As this project uses async/await syntax, the lowest supported Python version is
3.5.
./dropin.py to download base24-builder-python-portableThere are three modes of operation:
./base24.py update./base24.py build./base24.py inject
If you just want to build all base24 colorschemes and then pick out the ones you
need, simply run:
./base24.py update./base24.py build
Once the process is finished, you can find all colorschemes in a folder named
output located in the current working directory.
For a more detailed explanation of the individual commands, read on.
Downloads all base24/ base16 schemes and templates to the current working
directory.
The source files, i.e. the files pointing to the scheme and template
repositories
will also be updated by default. If you want to use your own versions of these
files (to exclude specific repositories, for example), you can prevent the
builder from updating the source files by using the -c/--custom option.
You can use -v/--verbose for more detailed output.
Builds base24 colorschemes for all schemes and templates. This requires the
directory structure and files created by the update operation to be present in
the working directory. This operation accepts four parameters:
-s/--scheme restricts building to specific schemes
Can be specified more than once. Each argument must match a scheme.
Wildcards can be used but must be escaped properly so they are not expanded
by the shell.
-o/--output specifies a path where built colorschemes will be placed
If this option is not specified, an “output” folder in the current working
directory will be created and used.
-v/--verbose increases verbosity
With this option specified the builder prints out the name of each scheme as
it’s built.
Example:
./base24.py build -s atelier-heath-light -o /tmp/output
This operation provides an easier way to quickly insert a specific colorscheme
into one or more config files. In order for the builder to locate the necessary
files, this command relies on the folder structure created by the update
command. The command accepts two parameters:
-s/--scheme specifies the scheme you wish to inject
Refers to the scheme that should be inserted. You can use wildcards and the
same restrictions as with update apply. A pattern that matches more than one
scheme will cause an error.
-f/--file specifies the file(s) into which you wish the scheme to be
inserted
Can be specified more than once. Each argument must be specified as a path
to a config file that features proper injection markers (see below).
You will need to prepare your configuration files so that the script knows where
to insert the colorscheme. This is done by including two lines in the file
# %%base24_template: TEMPLATE_NAME##SUBTEMPLATE_NAME %%Everything in-between these two lines will be replaced with the colorscheme.# %%base24_template_end%%
Both lines can feature arbitrary characters before the first two percentage
signs. This is so as to accomodate different commenting styles. Both lines
need to end exactly as demonstrated above, however. “TEMPLATENAME” and
“SUBTEMPLATE_NAME” are the exception to this. Replace TEMPLATE_NAME with the
name of the template you wish to insert, for example “gnome-terminal”. This
must correspond to a folder in the templates directory. Replace
SUBTEMPLATE_NAME with the name of the subtemplate as it is defined at the
top level of the template’s config.yaml file (seefile.md <https://github.com/chriskempson/base16/blob/master/file.md> for
details), for example “default-256”. If you omit the subtemplate name (don’t
omit “##” though), “default” is assumed.
Specify the name of the scheme you wish to inject with the -s option. Use the
-f option for each file into which you want to inject the scheme.
As an example, here’s the command I use to globally change the color scheme in
all applications that support it:
./base24.py inject -s ocean -f ~/.gtkrc-2.0.mine -f ~/.config/dunst/dunstrc -f~/.config/i3/config -f ~/.config/termite/config -f ~/.config/zathura/zathurarc
The program exits with exit code 1 if it encountered a general error and with
2 if one or more build or update tasks produced a warning or an error.
This program has been written for Python 3 and has been tested with
Python version 3.8.0 https://www.python.org/downloads/release/python-380.
choco install python
To install Python, go to https://www.python.org and download the latest
version.
sudo apt install python3.8
./[file].py
Windows
wget dephell.org/install | python3.8wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3.8
(wget dephell.org/install -UseBasicParsing).Content | python(wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python
poetry updatedephell deps convert
or
poetry buildpoetry publish
poetry publish --build
$ git clone https://github.com/Base24/base24-builder-python
More information can be found at
https://help.github.com/en/articles/cloning-a-repository
More information can be found at
https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop
If you don’t want to clutter your computer with something that you’re just
going to use once you can also just clone this repository and use the provided base24.py file.
MIT License
(See the LICENSE for more information.)
See the Changelog for more information.
In the interest of fostering an open and welcoming environment, we
as contributors and maintainers pledge to make participation in our
project and our community a harassment-free experience for everyone.
Please see the
Code of Conduct for more information.
Contributions are welcome, please see the Contributing Guidelines for more information.
Thank you for improving the security of the project, please see the Security Policy for more information.