All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
- Fixed a bug when searching for multiple cities, as the API parameters require separate parameters for each city.
- Now allows multiple emails with the
--email(-e) argument.
- We now use the Boligsiden API instead of scraping the website. This makes the application much faster and more reliable, as we no longer have to deal with changes to the website layout. It also puts less load on the Boligsiden servers.
- The cache has been renamed to
.bolig_ping_cachefrom.boligping_cache. To ensure that this is backwards compatible, we will rename.boligping_cacheto.bolig_ping_cacheif the former exists and not the latter.
- Check whether the
GMAIL_EMAILandGMAIL_PASSWORDenvironment variables are set before doing anything.
- Optimised the caching, which now ensures that we do not have to check a property listing twice. This was not always the case, as we only cached the ones that were sent to the given email, and not the ones that were filtered out.
- Added
--headless/--no-headlessflag, which is mostly used for debugging.
- No requirement of the
--cityargument now; it defaults to all cities in Denmark. - All arguments now defaults to None, meaning that the default behaviour of Boligsiden.dk is used, which currently is exactly the same as the previous behaviour.
- Better detection of when the inputted city name is invalid.
- Added the ability to search for different property types, with the new
--property-type(-t) option. The available property types areejerlejlighed,andelslejlighedandhouse. You can specify multiple property types with, e.g.,bolig-ping <other-arguments> -t ejerlejlighed -t house. It defaults toejerlejlighed, which is the only type that was previously supported. - Added new
--min-monthly-feeand--max-monthly-feeoptions to filter flats by monthly fee. The default is no minimum or maximum monthly fee. - Added new
--cache/--no-cacheflag, which allows you to disable the cache. The default behaviour is still to use the cache, but you can disable it by using the--no-cacheflag. This is useful if you want to see all the results, and not just the new ones. The cache is stored in the.boligping_cachefile in the current directory.
- Changed the
--query(-q) option to now search for the selected keywords in the description of the flat, rather than use Boligsiden.dk's own keywords, since many flats do not use these keywords. Remember that you can specify multiple queries with, e.g.,bolig-ping <other-arguments> -q badekar -q altan.
- Now catches when an invalid city name is provided, and returns a helpful error message. Previously, it would just print the raw traceback.
- Added CLI command aliases
bolig-pingandboligping.
- Added support for
--max-roomsand--max-size.
- Initial version of the project, featuring the ability to fetch data on new flats (ejerlejligheder) from Boligsiden.dk, and sending email notifications when new flats are found.