commit 88bf1061ccc1ffaa60118d8708ae8cbc6d1f1d8f Author: Yigid BALABAN Date: Mon Sep 16 00:41:21 2024 +0300 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..e7ab70e --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +.venv/ +dotm.egg-info/ +dist/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ecbc059 --- /dev/null +++ b/LICENSE @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..e547238 --- /dev/null +++ b/README.md @@ -0,0 +1,46 @@ +# dotm + +dotm: **D**otfiles **O**rganized, **T**racked, and **M**anaged. + +dotm is my take on $HOME and `.config` directory backup solutions. Originally authored in March 15, 2022 with [this commit](https://github.com/fybx/scripts/commit/0b4f6f32e1b94603a0ae549ec3342ce79a5b81a7), dotm now is a stable and well-thought solution. + +## features + +- [x] backup/deploy to/from a remote repository +- [ ] add comments to backups +- [ ] create tags with backups & deploy tags +- [ ] track deletions (in a seperate commit) + +### technical features + +- [ ] use LUT to improve backup/deploy times if `deploy_list` is not changed +- [ ] message and log at the same time +- [ ] provide AUR package + +## how to use? + +1. acquire dotm +2. `dotm init --local -u https://example.org/~user/dotfiles` +3. create whitelist `deploy_list` at `.config/dotm/deploy_list` +4. `dotm backup` + +Congrats! You've successfully committed your configuration. + +For a detailed walkthrough, see [docs/usecases.md](docs/usecases.md). + +## credits + +Feel free to contact me for collaboration on anything! + +Yiğid BALABAN, <[fyb@fybx.dev][llmail]> + +[My Website][llwebsite] • [My Bento][llbento] • [X][llx] • [LinkedIn][lllinkedin] + +2024 + +[llmail]: mailto:fyb@fybx.dev +[llwebsite]: https://fybx.dev +[llbento]: https://bento.me/balaban +[llx]: https://x.com/fybalaban +[lllinkedin]: https://linkedin.com/in/fybx + diff --git a/docs/usecases.md b/docs/usecases.md new file mode 100644 index 0000000..5f02bc0 --- /dev/null +++ b/docs/usecases.md @@ -0,0 +1,34 @@ +# dotm docs + +## usecases + +A complete list of use cases that dotm covers is as follows: + +### 1. initial setup (no local, no remote) + +```bash +dotm init -l -u "remote_url" +nvim .config/dotm/deploy_list # whitelist folders and files here to backup +dotm backup +``` + +This will create and initialize a local repository with origin, then commit configuration, and push to remote. + +### 2. new instance, old configuration (no local, remote exists) + +```bash +dotm init -d -u "remote_url" +``` + +This will setup clone the local repository from remote, then deploy the configuration to place. + +### 3. new instance, local configuration is newer than remote (no local, remote exists is out-of-date) + +```bash +dotm init -u "remote_url" +nvim .config/dotm/deploy_list # whitelist folders and files here to backup +dotm backup +``` + +This is almost the same as the first usecase, however we don't deploy the remote configuration as soon as we clone to local. + diff --git a/dotm.py b/dotm.py new file mode 100755 index 0000000..e340095 --- /dev/null +++ b/dotm.py @@ -0,0 +1,307 @@ +#!/usr/bin/env python3 +# +# Yiğid BALABAN , 2024 +# + +# dotm +# +# [S] Description +# dotm is a simple dotfiles manager that can be used to backup and deploy dotfiles. +# +# It manages a git repository to deploy a list of files and directories to +# the local .config directory. When the backup command is executed, it +# copies the files and directories in the deploy_list to the +# local repository. git is used to keep track of changes. +# +# Deploying a configuration is possible by either directly calling it, or +# by specifying a git tag. The tag is used to checkout the repository to a +# specific commit, and then deploy the configuration on that time. +# +# Similar to deploying, backing up a configuration is possible by specifying +# a tag name. The tag is created after the files and directories are copied, +# essentially creating a snapshot of the configuration at that time. + +# [S] Details +# * The configuration file for dotm is located in $HOME/.config/dotm/config +# * The deploy list for selecting what and what not $HOME/.config/dotm/deploy_list +# to backup/deploy is searched in +# * The repository managed by dotm is located in $HOME/.local/state/dotm/managed_repo + +import os +import shutil +import sys + +from git.repo import Repo +from crispy.crispy import Crispy +from tomlkit import dumps as toml_dumps +from tomlkit import parse as toml_parse +from tomlkit.items import String as toml_String +from tomlkit.items import Item as toml_Item +from os.path import join, relpath + +VER = '1.0.1' +help_message = f'''dotm {VER} dotfiles/home backup helper by Yigid BALABAN + +Commands: +=> init Initialize dotm installation +-u, --url [required] the URL of remote +-l, --local [optional] create repository locally +-d, --deploy [optional] deploy configuration + +=> backup Backups configuration to managed_repo (pushes to remote) +=> deploy Deploys configuration in place from managed_repo (pulls remote) +=> help Prints this message. +=> version Prints the version. +''' + +INITIALIZED = False +dir_home = os.path.expandvars('$HOME') +dir_config = join(dir_home, '.config') +dir_state = join(dir_home, '.local', 'state') +params = {} + + +def u_path(mode, path): + if mode == 'deploy': + return join(params['managed_repo'], relpath(path, dir_home)) + elif mode == 'backup': + return join(params['managed_repo'], relpath(path, dir_home)) + else: + raise ValueError(mode) + + +def u_get_files(directory: str) -> list[str]: + if not os.path.exists(directory): + return [] + + files = [] + for root, _, filenames in os.walk(directory): + files.extend(join(root, filename) for filename in filenames) + return files + + +def t_init(): + global INITIALIZED + if INITIALIZED: + return + INITIALIZED = True + + global params + params = { + 'managed_repo': f'{dir_state}/dotm/managed_repo', + 'deploy_list': f'{dir_config}/dotm/deploy_list', + 'config_file': f'{dir_config}/dotm/config', + 'repo_url': '', + } + + if os.path.exists(params['config_file']): + with open(params['config_file'], 'r') as f: + data = toml_parse(f.read()) + params.update({k: str(v) if isinstance(v, (toml_String, toml_Item)) else v for k, v in data.items()}) + else: + with open(params['config_file'], 'w') as f: + f.write(toml_dumps(params)) + + +is_local_repo_created = lambda: os.path.exists(f"{params['managed_repo']}/.git") + + +def t_make_repo(from_url: str, local = False, check = True): + """ + Create the local repository either by cloning from a remote, or by initializing it. + + :param str from_url: URL of the remote + :param bool local: Whether to create locally (default = False) + :param bool check: Whether to check if local repository exists (default = True) + """ + if check and is_local_repo_created(): + print('[W] dotm: a managed repository was initialized. overriding contents') + if local: + r = Repo.init(params['managed_repo']) + r.create_remote('origin', url=from_url) + r.git.checkout('-b', 'main') + return + print(f'[I] dotm: cloning from remote {params['repo_url']}') + Repo.clone_from(from_url, params['managed_repo']) + + +def t_pull_repo(overwrite: bool): + try: + # clone the repo from remote if local doesn't exist + # or if we are allowed to overwrite existing local + p_local_exists = is_local_repo_created() + if not p_local_exists or overwrite: + if p_local_exists: + shutil.rmtree(params['managed_repo']) + t_make_repo(params['repo_url'], check=False) + else: + # repo exists and it's forbidden to overwrite + repo = Repo(params['managed_repo']) + repo.remotes.origin.pull() + except Exception as e: + print(f'[E] dotm: unhandled error in \'t_pull_repo\': {e}') + return False + return True + + +def t_set_params(param_key: str, param_value: str): + params[param_key] = param_value + with open(params['config_file'], 'w') as f: + f.write(toml_dumps(params)) + + +def t_list(p_list: str) -> list[str]: + l_i, l_d = [], [] + + with open(p_list, 'r') as f: + lines = f.readlines() + lines = [l.strip() for l in lines] + lines = [l for l in lines if l] + + for line in lines: + ignore_it = False + + if line.startswith('#'): + continue + + if line.startswith('!'): + ignore_it = True + line = line.removeprefix('!') + elif '.git' in line: + ignore_it = True + + line = join(dir_config, line[1:]) if line.startswith('%') else join(dir_home, line) + + if os.path.isfile(line): + if ignore_it: l_i.append(line) + else: l_d.append(line) + else: + if ignore_it: l_i.extend(u_get_files(line)) + else: l_d.extend(u_get_files(line)) + + for element in l_i: + if element in l_d: + l_d.remove(element) + + with open(join(dir_state, 'dotm', 'dotm.log'), 'w') as f: + f.writelines(map(lambda x: x + '\n', l_d)) + return l_d + + +def a_backup(): + l_deploy = t_list(params['deploy_list']) + + if len(l_deploy) == 0: + print('[W] dotm: deploy_list is not created or empty. nothing will be backed up.') + return False + + for file in l_deploy: + file_in_repo = u_path('backup', file) + os.makedirs(os.path.dirname(file_in_repo), exist_ok=True) + shutil.copy(file, file_in_repo) + + repo = Repo(params['managed_repo']) + repo.git.add(all=True) + + if repo.index.diff(None) or repo.untracked_files: + repo.git.commit('-m', 'committed by dotm') + repo.remotes.origin.push('main') + return True + + +def a_deploy(use_deploy_list_in_managed_repo = False): + l_deploy = t_list(os.path.join(params['managed_repo'], 'dotm', 'deploy_list')) if use_deploy_list_in_managed_repo else t_list(params['deploy_list']) + + if len(l_deploy) == 0: + print('[W] dotm: deploy_list is not created or empty. nothing will be deployed.') + return False + + for file in l_deploy: + file_in_repo = u_path('deploy', file) + os.makedirs(os.path.dirname(file), exist_ok=True) + shutil.copy(file_in_repo, file) + return True + + +def main(): + if len(sys.argv) == 1: + print(help_message) + sys.exit(0) + + t_init() + c = Crispy() + c.add_subcommand('init', 'Initialize dotm for use') + c.add_subcommand('config', 'Configure dotm') + c.add_variable('url', str) + c.add_variable('local', bool) + c.add_variable('deploy', bool) + + c.add_subcommand('deploy', 'Deploy a configuration to place') + c.add_subcommand('backup', 'Backup current state following a deploy list') + c.add_variable('tag', str) + + subcommand, args = c.parse_arguments(sys.argv[1:]) + + match subcommand: + case 'init': + if args['url'] and type(args['url']) == str: + t_set_params('repo_url', str(args['url'])) + if not args['local']: + s_pull = t_pull_repo(overwrite=True) + if args['deploy'] and s_pull: + a_deploy(True) + else: + t_make_repo(args['url'], True) + case 'config': + if args['url']: t_set_params('repo_url', str(args['url'])) + case 'deploy': + if t_pull_repo(False): + a_deploy() + case 'backup': + a_backup() + case 'help': + print(help_message) + case 'version': + print(VER) + case _: + print(help_message) + + +if __name__ == '__main__': + main() + + +# def backup(tag=''): +# """Copies files and directories denoted in deploy_list from their source to +# managed_repo directory. +# +# Args: +# tag (str, optional): Git tag to publish for the commit. Defaults to ''. +# """ +# if tag != '': +# if tag in map(lambda x: x.replace('refs/tags/', ''), repo.tags): +# return +# created_tag = repo.create_tag(tag) +# repo.remotes.origin.push(created_tag.name) + + +# def deploy(tag=''): +# """Copies files and directories in managed Git repository to +# local .config directory, if they are present in the deploy list. +# +# Optinally, a tag can be specified to deploy a specific configuration. +# +# Args: +# tag (str, optional): Git tag for a specific configuration. Defaults to ''. +# """ +# if tag != '': +# repo = Repo(params['managed_repo']) +# repo.git.checkout(tag) +# t_list() +# +# for file in list_deploy: +# file_in_repo = util_path('deploy', file) +# os.makedirs(os.path.dirname(file), exist_ok=True) +# shutil.copy(file_in_repo, file) + + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..53bf531 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,33 @@ +[build-system] +requires = ["setuptools", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "dotm" +description = "dotm: Dotfiles Organized, Tracked, and Managed." +version = "1.0.1" +authors = [ + { name = "F. Y. BALABAN", email = "fyb@fybx.dev" }, +] +readme = "README.md" +requires-python = ">3.10" +keywords = ["dotfiles", "backup", "CLI"] + +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Programming Language :: Python :: 3", + "Environment :: Console", + "License :: OSI Approved :: GNU General Public License v2 (GPLv2)", + "Operating System :: OS Independent", + "Natural Language :: English", + "Topic :: System :: Archiving", + "Topic :: System", + "Typing :: Typed", +] + +[project.urls] +homepage = "https://git.fybx.dev/fyb/dman" +issues = "https://github.com/fybx/dman/issues" + +[project.scripts] +dotman = "dotman:main"