Added readme, license

This commit is contained in:
rune 2023-04-16 18:46:18 +02:00
parent 6045e2d1a3
commit 700eb88061
4 changed files with 81 additions and 0 deletions

7
LICENSE Normal file
View File

@ -0,0 +1,7 @@
Copyright <2023> <Rune Olsen https://gitlab.pm/rune/malias>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

29
README.md Normal file
View File

@ -0,0 +1,29 @@
# DDNS
_malias_ is a helper for mailcow instances. You can create, delete, search and list aliases.
## Installation
Download the latest relase from https://gitlab.pm/rune/malias/releases. Unzip and move to a folder in you path (ease of use). You can also rename the file ```malias.py``` to just ```malias``` and make the file executable with ```chmod +x malias```. To install required python modules run ```pip3 install -r requirements.txt```
## Usage
For instructions run
```bash
malias -h
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.
## Support
If you found a bug or you have suggestion for new features create an issue.
## License
[<img src="https://gitlab.pm/rune/ddns/src/branch/main/mit.png">](https://gitlab.pm/rune/ddns/src/branch/main/LICENSE.md)

BIN
mit.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

45
requirements.txt Normal file
View File

@ -0,0 +1,45 @@
aiohttp==3.8.4
aiosignal==1.3.1
async-timeout==4.0.2
attrs==22.2.0
bleach==6.0.0
build==0.10.0
certifi==2022.12.7
cffi==1.15.1
charset-normalizer==3.1.0
click==8.1.3
docopt==0.6.2
docutils==0.19
frozenlist==1.3.3
gpg==1.19.0
idna==3.4
importlib-metadata==6.1.0
jaraco.classes==3.2.3
keyring==23.13.1
markdown-it-py==2.2.0
mdurl==0.1.2
more-itertools==9.1.0
multidict==6.0.4
notmuch==0.37
notmuch2==0.37
openai==0.27.0
packaging==23.0
pipreqs==0.4.11
pkginfo==1.9.6
promptcli==1.0.4
pycparser==2.21
Pygments==2.14.0
pyproject_hooks==1.0.0
readme-renderer==37.3
requests==2.28.2
requests-toolbelt==0.10.1
rfc3986==2.0.0
rich==13.3.1
six==1.16.0
tqdm==4.65.0
twine==4.0.2
urllib3==1.26.14
webencodings==0.5.1
yarg==0.1.9
yarl==1.8.2
zipp==3.15.0