44 lines
2.3 KiB
Markdown
44 lines
2.3 KiB
Markdown
# map-dots-fetch
|
|
|
|
A one-shot Python (3.11) script that fetches one or more images from a map-dots server.
|
|
|
|
Remember that map-dots can be run as a CLI application so if you are not looking to access map-dots images on more than one computer, you are probably best skipping this script and running map-dots locally.
|
|
|
|
|
|
## Running
|
|
|
|
map-dots-fetch uses imports from the standard-library with the exception of `requests`. You can choose to run it in a venv however it has been written to run in the global environment and should not interfere with any other Python applications that you are running.
|
|
|
|
map-dots-fetch requires a configuration file, an example of which is provided in this repository. The configuration file must be placed in one of these locations:
|
|
|
|
Linux systems:
|
|
- `~/.config/map-dots-fetch/conf.toml`
|
|
- `/etc/map-dots-fetch/conf.toml`
|
|
- `./conf.toml` In the same folder as map-dots-fetch.py
|
|
|
|
Windows systems:
|
|
- `C:\Users\{user}\map-dots-fetch.toml` Alongside your user files
|
|
- `./conf.toml`
|
|
|
|
If the config file exists in more than one place, the first file found will be loaded. Files are checked in the order they appear in the lists.
|
|
|
|
If no config file is present, the script will exit with an exit code of `1`.
|
|
|
|
|
|
## License
|
|
|
|
Copyright 2023 Frederick Boniface (git.fjla.uk/fredboniface.co.uk)
|
|
|
|
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.
|