Package: base24builder
base24-builder-pythonA base 24 builder written in PythonThank you tohttps://github.com/InspectorMustache/base16-builder-python(MIT)
for the original base16-builderInstallationInstall With PIPUsageBasic UsageUpdateBuildInjectExitLanguage informationBuilt forInstall Python on WindowsChocolateyDownloadInstall Python on LinuxAptHow to runWith VSCodeFrom the TerminalHow to update, build and publishDownloadCloneUsing The Command LineUsing GitHub DesktopDownload Zip FileCommunity FilesLicenceChangelogCode of ConductContributingSecurityInstallationAs this project uses async/await syntax, the lowest supported Python version is
3.5.Install With PIPpipinstallbase24builderHead tohttps://pypi.org/project/base24builder/for more infoUsageThere are three modes of operation:./base24.pyupdate
./base24.pybuild
./base24.pyinjectBasic UsageIf you just want to build all base24 colorschemes and then pick out the ones you
need, simply run:./base24.pyupdate
./base24.pybuildOnce 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.UpdateDownloads all base24/ base16 schemes and templates to the current working
directory.
The source files, i.e. the files pointing to the scheme and template
repositorieswill 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/--customoption.You can use-v/--verbosefor more detailed output.BuildBuilds 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/--schemerestricts building to specific schemesCan 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.-t/--templaterestricts building to specific templatesCan be specified more than once.  Each argument must correspond to a folder
name in the templates directory.-o/--outputspecifies a path where built colorschemes will be placedIf this option is not specified, an "output" folder in the current working
directory will be created and used.-v/--verboseincreases verbosityWith this option specified the builder prints out the name of each scheme as
it's built.Example:./base24.pybuild-tdunst-satelier-heath-light-o/tmp/outputInjectThis 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/--schemespecifies the scheme you wish to injectRefers 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/--filespecifies the file(s) into which you wish the scheme to be
insertedCan 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 %%Everythingin-betweenthesetwolineswillbereplacedwiththecolorscheme.# %%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.  "TEMPLATE_NAME" 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.pyinject-socean-f~/.gtkrc-2.0.mine-f~/.config/dunst/dunstrc-f
~/.config/i3/config-f~/.config/termite/config-f~/.config/zathura/zathurarcExitThe 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.Language informationBuilt forThis program has been written for Python 3 and has been tested with
Python version 3.8.0https://www.python.org/downloads/release/python-380/.Install Python on WindowsChocolateychocoinstallpythonDownloadTo install Python, go tohttps://www.python.org/and download the latest
version.Install Python on LinuxAptsudoaptinstallpython3.8How to runWith VSCodeOpen the .py file in vscodeEnsure a python 3.8 interpreter is selected (Ctrl+Shift+P > Python:Select
Interpreter > Python 3.8)Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)From the Terminal./[file].pyHow to update, build and publishEnsure you have installed the following dependencies
Linuxwgetdephell.org/install|python3.8
wgethttps://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py|python3.8Windows(wgetdephell.org/install-UseBasicParsing).Content|python(wgethttps://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py-UseBasicParsing).Content|pythonUse poetry for the heavy lifting and dephell to generate requirementspoetryupdate
dephelldepsconvertBuild/ Publishpoetrybuild
poetrypublishorpoetrypublish--buildDownloadCloneUsing The Command LinePress the Clone or download button in the top rightCopy the URL (link)Open the command line and change directory to where you wish to
clone toType 'git clone' followed by URL in step 2$gitclonehttps://github.com/Base24/base24-builder-pythonMore information can be found athttps://help.github.com/en/articles/cloning-a-repositoryUsing GitHub DesktopPress the Clone or download button in the top rightClick open in desktopChoose the path for where you want and click CloneMore information can be found athttps://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktopDownload Zip FileDownload this GitHub repositoryExtract the zip archiveCopy/ move to the desired locationIf 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.Community FilesLicenceMIT License
(See theLICENSEfor more information.)ChangelogSee theChangelogfor more information.Code of ConductIn 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 theCode of Conductfor more information.ContributingContributions are welcome, please see theContributing Guidelinesfor more information.SecurityThank you for improving the security of the project, please see theSecurity Policyfor more information.