Skip to content
This repository was archived by the owner on May 12, 2025. It is now read-only.

Commit 53a115e

Browse files
committed
Update README and setup.py
1 parent 03e4fae commit 53a115e

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Firebase Dynamic Links python client
22

33
Simple python client to generate [Firebase Dynamic Links](https://firebase.google.com/docs/dynamic-links/). It allows to
4-
use a custom domain and fields for generate links for android and ios. Check this fields in this [link](https://firebase.google.com/docs/reference/dynamic-links/link-shortener).
4+
use a custom domain and fields for generate links for android and ios.
55

66

77
### Requirements
@@ -23,7 +23,7 @@ from firebase_dynamic_links import DynamicLinks
2323
api_key = 'your_api_key'
2424
domain = 'example.page.link'
2525
timeout = 10
26-
dl = DynamicLinks(api_key, domain, timeout)
26+
dl = DynamicLinks(api_key, domain, timeout) # or DynamicLinks(api_key, domain)
2727
params = {
2828
"androidInfo": {
2929
"androidPackageName": 'packagename',
@@ -35,7 +35,7 @@ params = {
3535
# dl.generate_dynamic_link(url_to_redirect)
3636
short_link = dl.generate_dynamic_link('http://google.es', True, params) #https://example.page.link/h77c
3737
```
38-
* `api_key`: [Api from firebase console](https://console.firebase.google.com/project/_/settings/general/)
38+
* `api_key`: [Key from firebase console](https://console.firebase.google.com/project/_/settings/general/)
3939
* `domain`: Domain uri prefix created in firebase console. For example `example.page.link` or your custom domain.
4040
* `timeout`: Timeout for the api call
4141
* `params`: Dictionary of optional params. For example:
@@ -60,5 +60,5 @@ short_link = dl.generate_dynamic_link('http://google.es', True, params) #https:/
6060

6161

6262
### Reference
63-
[https://firebase.google.com/docs/dynamic-links/rest](https://firebase.google.com/docs/dynamic-links/rest)
63+
[https://firebase.google.com/docs/dynamic-links/rest](https://firebase.google.com/docs/dynamic-links/rest)
6464
[https://firebase.google.com/docs/reference/dynamic-links/link-shortener](https://firebase.google.com/docs/reference/dynamic-links/link-shortener)

setup.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
description="Python client for Firebase Dynamic Links API",
1212
long_description=long_description,
1313
long_description_content_type="text/markdown",
14-
maintainer="[email protected]",
14+
maintainer="Daniel Vilar Peiteado",
1515
maintainer_email="[email protected]",
1616
keywords=["firebase", "dynamic links", "url shortener"],
1717
url="https://github.com/dpeite/py-firebase-dynamic-links",
@@ -24,5 +24,10 @@
2424
"Intended Audience :: Developers",
2525
"Topic :: Software Development :: Libraries :: Python Modules",
2626
],
27-
install_requires=["requests"]
27+
install_requires=["requests"],
28+
project_urls={
29+
'Bug Reports': 'https://github.com/dpeite/py-firebase-dynamic-links/issues',
30+
'Source': 'https://github.com/dpeite/py-firebase-dynamic-links',
31+
},
32+
2833
)

0 commit comments

Comments
 (0)