[![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!
Raw data
{
"_id": null,
"home_page": "https://github.com/andres-ortizl/mypydot",
"name": "mypydot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11.1,<4.0.0",
"maintainer_email": "",
"keywords": "mypydot,dotfiles,python",
"author": "Andr\u00e9s Ortiz",
"author_email": "andrs.ortizl@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ab/d9/449089818d92c10a92cd30e219d3e704bccad2ee856ebbb4a5aeb639ed29/mypydot-2023.0.1.tar.gz",
"platform": null,
"description": "[![PyPI version](https://badge.fury.io/py/mypydot.svg)](https://badge.fury.io/py/mypydot)\n![CI](https://github.com/andres-ortizl/mypydot/actions/workflows/main.yml/badge.svg)\n[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=mypydot&metric=coverage)](https://sonarcloud.io/summary/new_code?id=mypydot)\n[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=mypydot&metric=bugs)](https://sonarcloud.io/summary/new_code?id=mypydot)\n\n## Mypydot\n\nMypydot is a tool created for managing your dotfiles using a Python application\n\n## Showcase\n\nsmall screenshots of the application\n\n| | |\n|-------------------------------------------|-----------------------------------------|\n| ![Home](screenshots/home.png) | ![selection](screenshots/selection.png) |\n| ![Installing](screenshots/installing.png) | ![Bye](screenshots/bye.png) |\n\n# Motivation\n\nI just wanted the basic functionality to manage my own dotfiles. I decided to do it in Python because It seems more\nnatural\nto me rather than do It using shell scripting.\n\n## Install\n\n```pip install mypydot```\n\n## Instructions\n\n### Create new dotfiles\n\nUsing it for the first time : ```mypydot``` . This command will create a new folder called .mypydotfiles\nin your $HOME directory. In this folder you will find the following folder structure :\n\n| Folder | |\n|------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `language` | In case you want to save some dotfiles related with your favourite programming languages |\n| `os` | Operating system dotfiles |\n| `shell` | Small setup of aliases and exports that can be accessed from everywhere |\n| `config` | Docker, Git, Editors, etc. You can also find here a few almost empty scripts for storing your aliases, exports and functions. |\n| `conf.yml` | This file contains every file that you want to track in your dotfiles repository, feel free to add & remove symlinks ! |\n\nOnce you run this process you will notice that you have a few new lines your .bashrc and in your .zshrc\n\n```\nexport MYPYDOTFILES=/Users/username/.mypydotfiles\nsource $MYPYDOTFILES/shell/main.sh\n```\n\nThis lines will be used to source yours aliases, exports and functions to be available in your terminal.\nBesides that, nothing else is edited.\n\n### Resync dotfiles\n\nSelect your existing conf file and the modules you want to resync / install\n\n# References\n\nhttps://github.com/mathiasbynens/dotfiles\n\nhttps://github.com/CodelyTV/dotly\n\nhttps://github.com/denisidoro/dotfiles\n\nhttps://github.com/webpro/awesome-dotfiles\n\nThank you!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python package to manage your dotfiles",
"version": "2023.0.1",
"split_keywords": [
"mypydot",
"dotfiles",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "abd9449089818d92c10a92cd30e219d3e704bccad2ee856ebbb4a5aeb639ed29",
"md5": "cf7a27b101c0eda8d6ce3f11fc8a1d48",
"sha256": "78289a4b59f29b4370c1fd1b2aa7dea6d60d0c71e1bfa092fb4a61bcb7ff8a13"
},
"downloads": -1,
"filename": "mypydot-2023.0.1.tar.gz",
"has_sig": false,
"md5_digest": "cf7a27b101c0eda8d6ce3f11fc8a1d48",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11.1,<4.0.0",
"size": 9426,
"upload_time": "2023-01-15T18:38:23",
"upload_time_iso_8601": "2023-01-15T18:38:23.472011Z",
"url": "https://files.pythonhosted.org/packages/ab/d9/449089818d92c10a92cd30e219d3e704bccad2ee856ebbb4a5aeb639ed29/mypydot-2023.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-15 18:38:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "andres-ortizl",
"github_project": "mypydot",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "mypydot"
}