Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kirbo/posti
Posti Basic Address auto-updater
https://github.com/kirbo/posti
Last synced: 4 months ago
JSON representation
Posti Basic Address auto-updater
- Host: GitHub
- URL: https://github.com/kirbo/posti
- Owner: Kirbo
- License: mit
- Created: 2018-03-12T18:15:06.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T04:09:26.000Z (about 2 years ago)
- Last Synced: 2024-10-01T15:04:48.272Z (4 months ago)
- Language: JavaScript
- Size: 2.25 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# POSTI
[](https://posti.devaus.eu/coverage)
## Description
`posti` is a tool to automagically download latest basic address data from [Finnish post - Posti](https://www.posti.fi/), to parse the files and insert the contents into database. **Check also [`posti-graphql`](https://www.npmjs.com/package/posti-graphql).**
## Changelog
Check changes [here](./CHANGELOG.md).
## Posti
**Postal Code Services - Homepage:**
- [Finnish](https://support.posti.fi/fi/postinumeropalvelut/postinumerotiedostot.html)
- [English](https://www.posti.fi/business/help-and-support/postal-code-services/postal-code-files.html)
- [Swedish](https://www.posti.fi/foretag/hjalp-och-stod/postnummertjanster/postnummerfiler.html)
**Postal Code Services – Service Description and Terms Of Use:**
- [Finnish](https://www.posti.fi/liitteet-yrityksille/ehdot/postinumeropalvelut-palvelukuvaus-ja-kayttoehdot.pdf)
- [English](https://www.posti.fi/liitteet-yrityksille/ehdot/postinumeropalvelut-palvelukuvaus-ja-kayttoehdot-en.pdf)
- [Swedish](https://www.posti.fi/liitteet-yrityksille/ehdot/postinumeropalvelut-palvelukuvaus-ja-kayttoehdot-sv.pdf)
**Postal Code Services – Frequently Asked Questions:**
- [Finnish](https://www.posti.fi/liitteet-yrityksille/muut/postinumeropalvelut-faq.pdf)
- [English](https://www.posti.fi/liitteet-yrityksille/muut/postinumeropalvelut-faq-en.pdf)
- [Swedish](https://www.posti.fi/liitteet-yrityksille/muut/postinumeropalvelut-faq-sv.pdf)
There are 3 different files:
* **BAF** (Basic Address File) - Updated every saturday at 13:00 (1:00 PM) GMT+0
* **PCF** (Postal Code File) - Updated every day at 13:00 (1:00 PM) GMT+0
* **POM** (Postal Code Changes) - Updated on 2nd day of each month at 13:00 (1:00 PM) GMT+0
This tool downloads the latest files and processes only the ones that have been updated,
so you can setup the automation to be run as often as you like, but I would suggest you not to
run this more than once per day.
The files above can be found here:
- https://www.posti.fi/webpcode/
## TIPS
While executing this tool, it will try to automatically find the config file from these paths, in this order:
- `/posti.config.js`
- `/.posti/config.js`
You can also specify a custom path for the config file, with either:
```
posti --config=/path/to/config
```
..or:
```
config=/path/to/config posti
```
You can also use `~` in the path, which will be converted as your home directory path automatically, so e.g.: `config=~/.posti.js` is going to be converted into e.g.: `config=/home/user/.posti.js`.
This tool uses [`Sequelize`](https://github.com/sequelize/sequelize), therefore this tool supports/should support:
- MySQL / MariaDB
- Postgres
- SQLite
- Microsoft SQL Server
I've only tested the usage with MariaDB, so please, if you try any other of the supported databases, let me know if you're having issues and/or if its working, so that I can update this readme.
## Force update
You can bypass the checks and force this tool to process each of the files, by `force=true posti`.
## Installation as a dependency for your project
1. Install the dependency
```
yarn add posti
```
or:
```
npm install posti
```
2. Create a `posti.config.js` file in your project root with the contents of [posti.config.example.js](./posti.config.example.js)
3. Create a `npm` script in your `package.json` file:
```javascript
"scripts": {
"update-posti": "posti"
}
```
4. Run the script:
```
yarn update-posti
```
or:
```
npm run update-posti
```
## Installation as a global command
1. Install the package
```
yarn global add posti
```
or:
```
npm install -g posti
```
2. Create a `.posti/config.js` file in your home dir with the contents of [posti.config.example.js](./posti.config.example.js)
3. Run the script:
```
posti
```
## Links
- [Test coverages](https://posti.devaus.eu/coverage/)
- [Screencapture of running the script](https://posti.devaus.eu/screencapture.gif)
- [Screenshot of executed script](https://posti.devaus.eu/screenshot.png)
- [Screenshot of executed tests](https://posti.devaus.eu/tests.png)
## Disclaimer
I am not in any way affiliated with nor do I represent anything from [Finnish post - Posti](https://www.posti.fi/).
## License
MIT License
Copyright (c) 2018 Kimmo Saari
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.