Metadata-Version: 2.1
Name: mypydot
Version: 2023.0.1
Summary: Python package to manage your dotfiles
Home-page: https://github.com/andres-ortizl/mypydot
License: MIT
Keywords: mypydot,dotfiles,python
Author: Andrés Ortiz
Author-email: andrs.ortizl@gmail.com
Requires-Python: >=3.11.1,<4.0.0
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: PyTermGUI (>=7.3.0,<8.0.0)
Requires-Dist: PyYAML (==6.0)
Requires-Dist: emoji (>=2.2.0,<3.0.0)
Project-URL: Repository, https://github.com/andres-ortizl/mypydot
Description-Content-Type: text/markdown

[![PyPI version](https://badge.fury.io/py/mypydot.svg)](https://badge.fury.io/py/mypydot)
![CI](https://github.com/andres-ortizl/mypydot/actions/workflows/main.yml/badge.svg)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=mypydot&metric=coverage)](https://sonarcloud.io/summary/new_code?id=mypydot)
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=mypydot&metric=bugs)](https://sonarcloud.io/summary/new_code?id=mypydot)

## Mypydot

Mypydot is a tool created for managing your dotfiles using a Python application

## Showcase

small screenshots of the application

|                                           |                                         |
|-------------------------------------------|-----------------------------------------|
| ![Home](screenshots/home.png)             | ![selection](screenshots/selection.png) |
| ![Installing](screenshots/installing.png) | ![Bye](screenshots/bye.png)             |

# Motivation

I just wanted the basic functionality to manage my own dotfiles. I decided to do it in Python because It seems more
natural
to me rather than do It using shell scripting.

## Install

```pip install mypydot```

## Instructions

### Create new dotfiles

Using it for the first time : ```mypydot``` . This command will create a new folder called .mypydotfiles
in your $HOME directory. In this folder you will find the following folder structure :

| Folder     |                                                                                                                               |
|------------|-------------------------------------------------------------------------------------------------------------------------------|
| `language` | In case you want to save some dotfiles related with your favourite programming languages                                      |
| `os`       | Operating system dotfiles                                                                                                     |
| `shell`    | Small setup of aliases and exports that can be accessed from everywhere                                                       |
| `config`   | Docker, Git, Editors, etc. You can also find here a few almost empty scripts for storing your aliases, exports and functions. |
| `conf.yml` | This file contains every file that you want to track in your dotfiles repository, feel free to add & remove symlinks !        |

Once you run this process you will notice that you have a few new lines your .bashrc and in your .zshrc

```
export MYPYDOTFILES=/Users/username/.mypydotfiles
source $MYPYDOTFILES/shell/main.sh
```

This lines will be used to source yours aliases, exports and functions to be available in your terminal.
Besides that, nothing else is edited.

### Resync dotfiles

Select your existing conf file and the modules you want to resync / install

# References

https://github.com/mathiasbynens/dotfiles

https://github.com/CodelyTV/dotly

https://github.com/denisidoro/dotfiles

https://github.com/webpro/awesome-dotfiles

Thank you!

