Skip to content

Commit c639595

Browse files
committed
Rename project to userlist-python to avoid naming conflict with Python Standard Library
1 parent 434ce06 commit c639595

11 files changed

Lines changed: 16 additions & 18 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The official Python client library to manipulate [Userlist](https://userlist.com/) from your Python application.
44

5-
Documentation is identical with the API documentation. The same parameters and filters are available.
5+
Documentation is identical with the API documentation. The same parameters and filters are available.
66
And the same response structure. You can have a look at [Docs](https://userlist.com/docs/getting-started/integration-guide/#setting-up-the-integration).
77

88
## Authentication
@@ -17,7 +17,7 @@ Check your Push key at [Userlist Settings](https://app.userlist.com/settings/pus
1717
## Quick Start
1818
Import installed package.
1919

20-
`````from userlist import UserlistApiClient`````
20+
`````from userlist_python import UserlistApiClient`````
2121

2222
Init the instance with an API key given after registration.
2323

@@ -80,7 +80,7 @@ response = userlist_client.push_companies(
8080
```
8181

8282
### Deleting Companies (/companies/{{identifier}})
83-
You can remove company data by sending a DELETE request to `https://push.userlist.com/companies/{{identifier}}`.
83+
You can remove company data by sending a DELETE request to `https://push.userlist.com/companies/{{identifier}}`.
8484
The identifier is the same one you sent when sending the company data initially. We’ll process your deletion request
8585
within a few of moments and remove the company, all its events, as well as all relationships to users. The users that
8686
where part of that company are not deleted automatically. If you send any data or event with this company after
@@ -107,7 +107,7 @@ response = userlist_client.push_relationships(
107107
```
108108

109109
### Deleting relationships (/relationships/{{user-identifier}}/{{company-identifier}})
110-
You can remove a relationship data by sending a DELETE request to
110+
You can remove a relationship data by sending a DELETE request to
111111
`https://push.userlist.com/relationships/{{user-identifier}}/{{company-identifier}}`. We’ll process your deletion
112112
request within a few of moments and remove the relationship between this user and this company. Both the associated user
113113
and company are not deleted automatically.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[tool.poetry]
2-
name = "userlist"
2+
name = "userlist-python"
33
version = "0.1.0"
44
description = "Official UserList SDK for Python"
55
authors = ["Maksym Sugonyaka <maksym@newscatcherapi.com>"]
66
readme = "README.md"
77

88
homepage = "https://userlist.com/"
99
license = "MIT"
10-
keywords = ["Emailing","Userlist", 'marketing']
10+
keywords = ["Emailing", "Userlist", "marketing"]
1111

1212
[tool.poetry.dependencies]
1313
python = ">=3.6.0"

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818

1919
if __name__ == "__main__":
2020
setup(
21-
name="userlist",
21+
name="userlist-python",
2222
version=VERSION,
2323
author="Maksym Sugonyaka",
2424
author_email="maksym@newscatcherapi.com",
25-
url="https://github.com/NewscatcherAPI/newscatcherapi-sdk-python",
25+
url="https://github.com/userlist/userlist-python",
2626
packages=find_packages(),
2727
install_requires=INSTALL_REQUIRES,
2828
tests_require=TESTS_REQUIRE,

tests/test_userlist.py

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
from userlist.userlist_auth import UserlistApiAuth
1+
from userlist_python.userlist_auth import UserlistApiAuth
22

33
import os
44
import unittest
5-
from userlist.userlist_client import UserlistApiClient
5+
from userlist_python.userlist_client import UserlistApiClient
66

77
class UserlistApiTest(unittest.TestCase):
88
def setUp(self):
@@ -18,5 +18,3 @@ def setUp(self):
1818
# assert userlist.request_method['Content-Type'] == 'application/json; charset=utf-8'
1919
# assert userlist.request_method['Accept'] == 'application/json'
2020
# assert userlist.request_method['Authorization'] == 'Push ' + self.key
21-
22-

userlist/__init__.py

Lines changed: 0 additions & 1 deletion
This file was deleted.

userlist_python/__init__.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
from userlist_python.userlist_client import UserlistApiClient
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
sys.path.append(os.getcwd())
99

1010

11-
from userlist import const, utils
12-
from userlist.userlist_auth import UserlistApiAuth
13-
from userlist.userlist_exception import UserlistApiException
11+
from userlist_python import const, utils
12+
from userlist_python.userlist_auth import UserlistApiAuth
13+
from userlist_python.userlist_exception import UserlistApiException
1414

1515

1616
class UserlistApiClient(object):
@@ -480,4 +480,4 @@ def push_events(
480480
raise UserlistApiException(r.json())
481481

482482
print(f'Successful push => {str(r.status_code)}')
483-
return r.status_code
483+
return r.status_code

0 commit comments

Comments
 (0)