diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8aa2645 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) [year] [fullname] + +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..99886ee --- /dev/null +++ b/README.md @@ -0,0 +1,42 @@ + +# AHV Checker + +Ein Tool, welches alle Personen in einer MiData Ebene findet, welche noch keine AHV-Nummer hinterlegt haben. + + +## Support + +Wenn du nicht in der Command Line zu Hause bist helfen wir dir gerne: + + +## Installation + + + +```bash +git clone git@github.com:pfadipatria/ahv-checker.git +cd ahv-checker +python3 -m venv venv/ +source venv/bin/activate +``` + +## Environment Variables + +To run this project, you will need to add the following environment variables to your `.env` file. + +`GROUP`: Top level group in MiData + +`USERNAME`: Username of your MiData account + +`PASSWORD`: Password of your MiData account + + +## Authors + +- [wombat](https://wombat.monster/) @ [Pfadi Patria](https://www.pfadipatria.ch/) + + +## License + +[MIT](https://choosealicense.com/licenses/mit/) +