Skip to content

Commit bb8fc74

Browse files
committed
+usage
1 parent 0b3e959 commit bb8fc74

File tree

2 files changed

+30
-1
lines changed

2 files changed

+30
-1
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,25 @@
55
```bash
66
python3 -m pip install --user dephell_changelogs
77
```
8+
9+
## Usage
10+
11+
Get changelog url:
12+
13+
```python
14+
from dephell_changelogs import get_changelog_url
15+
16+
url = get_changelog_url('dephell')
17+
url = get_changelog_url('https://dephell.readthedocs.io/')
18+
url = get_changelog_url('https://github.com/dephell/dephell/')
19+
```
20+
21+
Parse changelog:
22+
23+
```python
24+
from dephell_changelogs import parse_changelog
25+
26+
parsed = parse_changelog(url)
27+
parsed['0.8.0']
28+
# 'New commands:\n\n+ [dephell package bug]...'
29+
```

dephell_changelogs/_parser.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
import re
33
from typing import Dict, Optional
44

5+
# external
6+
import requests
7+
58

69
rex_version = re.compile(r'[0-9]+\.[0-9]+\.[0-9]+')
710

@@ -47,8 +50,12 @@ def _get_version(line: str) -> Optional[str]:
4750

4851

4952
def parse_changelog(content: str) -> Dict[str, str]:
50-
changelog = dict()
53+
if content.startswith('https://') and len(content.split()) == 1:
54+
response = requests.get(url=content)
55+
response.raise_for_status()
56+
content = response.text
5157

58+
changelog = dict()
5259
version = None
5360
notes = []
5461
for line in content.splitlines():

0 commit comments

Comments
 (0)