Bolig Ping
Get a ping when your dream home in Denmark becomes available on Boligsiden.dk.
Developer:
- Dan Saattrup Nielsen (saattrupdan@gmail.com)
Quickstart
The easiest way to use the package is as a uv tool. You can simply start searching for properties using the following command:
uvx bolig-ping --city københavn
This both installs the package and runs the command. All the available options are listed below, but you can always get these by running the following command:
uvx bolig-ping --help
To be able to send emails, you have to create a Google app
password, and store both your Gmail email
address and the app password in the environment variables GMAIL_EMAIL and
GMAIL_PASSWORD, respectively. You can also simply store these in a .env file, as
follows:
GMAIL_EMAIL=<your-email>@gmail.com
GMAIL_PASSWORD=<your-app-password>
With this set up, you can now use the --email option to receive an email with new
properties that match your search criteria:
uvx bolig-ping --city københavn --email <receiving-email>
This will then send an email from your GMAIL_EMAIL to the receiving-email address.
You can also set up a recurring search if you have a server available. In this case, you
can add the following line to your crontab on a
server, to run the search every hour:
0 * * * * <uvx-full-path> bolig-ping <search-arguments>
Here <uvx-full-path> is the full path to the uvx command, which you can find by
running which uvx in your terminal.
All options
The following options are available:
--city/-c: The city you want to search in. This argument can be used several times to search in multiple cities, e.g.,-c aarhus -c odense. If you do not specify any city then you'll be searching for homes in all of Denmark!--min-price: The minimum price of the property, in DKK. Default is no minimum price.--max-price: The maximum price of the property, in DKK. Default is no maximum price.--min-monthly-fee: The minimum monthly fee of the property, in DKK. Default is no minimum monthly fee.--max-monthly-fee: The maximum monthly fee of the property, in DKK. Default is no maximum monthly fee.--min-rooms: The minimum number of rooms in the property. Default is no minimum number of rooms.--max-rooms: The maximum number of rooms in the property. Default is no maximum number of rooms.--min-size: The minimum size of the property, in square meters. Default is no minimum size.--max-size: The maximum size of the property, in square meters. Default is no maximum size.--query/-q: The query to search for in the property description. This argument can be used several times to search for multiple queries, e.g.,-q badekar -q altan.--property-type/-t: The type of property to search for. The available property types areejerlejlighed,andelslejlighedandhouse. This argument can be used several times to search for multiple property types, e.g.,-t ejerlejlighed -t house. Default is searching for all property types.--email: The email address you want to receive the ping on. Note that this needs to have theGMAIL_EMAILandGMAIL_PASSWORDenvironment variables set, as described above. Default is to use no email address, and instead print the properties to the console.--cache/--no-cache: Whether to use the cache or not. Default is 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.--headless/--no-headless: Whether to run the scraper in headless mode. Mostly used for debugging.
Metadata
Release files for bolig_ping 1.6.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| bolig_ping-1.6.1.tar.gz | 82.6 kB | Without provenance | Details for bolig_ping-1.6.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| bolig_ping-1.6.1-py3-none-any.whl | Python 3 | none | any | Details for bolig_ping-1.6.1-py3-none-any.whl |
Total release size: 94.2 kB
Release files / bolig_ping-1.6.1.tar.gz
| Download URL | bolig_ping-1.6.1.tar.gz |
|---|---|
| Size | 82.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
01ec17ce8a29a8cce655e11e351104a9e89d990bf9ac02f040504edaf2f701c2
|
|
BLAKE2b-256 checksum How to use checksums |
1249836a603ecf61d604ecc418a0bc7774315a349b162da1dc51dfa3b538877e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.16
|
Release files / bolig_ping-1.6.1-py3-none-any.whl
| Download URL | bolig_ping-1.6.1-py3-none-any.whl |
|---|---|
| Size | 11.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7429f693c99e7124e2c58ab9a4bd660e04c42842886497ebb66481200696837d
|
|
BLAKE2b-256 checksum How to use checksums |
bbde09ba3a91630a0449d6a38725e754e15d8d7772c1074c3b7cb05d7783f3d0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.6.16
|
Security for bolig_ping 1.6.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.