├── bandcamp_api
    ├── __init__.py
    ├── TODO.md
    ├── artist.py
    ├── bandcampjson.py
    ├── genres.py
    ├── label.py
    ├── track.py
    ├── search.py
    ├── bandcamp_api.py
    ├── album.py
    ├── daily.py
    └── homepage.py
├── setup.py
├── README.md
├── .gitignore
└── LICENSE


/bandcamp_api/__init__.py:
--------------------------------------------------------------------------------
1 | from .bandcamp_api import Bandcamp


--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
 1 | from setuptools import *
 2 | 
 3 | setup(
 4 |     name="bandcamp_api",
 5 |     version="0.2.2",
 6 |     description="Obtains information from bandcamp.com",
 7 |     author="RustyRin",
 8 |     packages=['bandcamp_api'],
 9 |     url="https://github.com/RustyRin/bandcamp-api/",
10 |     install_requires=["setuptools", "beautifulsoup4", "demjson3", 'html5lib', 'lxml', "requests"],
11 |     keywords=["api", "bandcamp"],
12 |     zip_safe=False
13 |     )
14 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # bandcamp-api
 2 | A simple way to get info from Bandcamp
 3 | 
 4 | This was based on and inspired by the work at [bandcamp-dl](https://github.com/iheanyi/bandcamp-dl)  
 5 | Thank you for making my work much easier!
 6 | 
 7 | #### Installation
 8 | `pip install bandcamp-api`
 9 | 
10 | #### Basic Use
11 | ```python
12 | from bandcamp_api import Bandcamp
13 | 
14 | bc = Bandcamp()
15 | 
16 | album = bc.get_album(album_url="https://c418.bandcamp.com/album/minecraft-volume-alpha")
17 | 
18 | print("Album title:", album.album_title)
19 | ```
20 | 
21 | For more information on the functions available see the [functions wiki](https://github.com/RustyRin/bandcamp-api/wiki/Functions) or the [object wiki](https://github.com/RustyRin/bandcamp-api/wiki/Bandcamp-api-Objects)
22 | 


--------------------------------------------------------------------------------
/bandcamp_api/TODO.md:
--------------------------------------------------------------------------------
 1 | # Things that I need to add
 2 | 
 3 | - Main Page
 4 |     - Get live streams
 5 |     - Get information about a live stream
 6 | 
 7 | - Merch
 8 |     - Given a artist URL
 9 |     - Get all merch items
10 |     - Get price, currency
11 |     - Get units sold, and total stock
12 |     - Get all pictures
13 |     - get shipping time
14 |     - Get merch type ('vinyl', 'T-Shirt/Shirt')
15 |     - when on the merch page, clicking on the merch brings you to the album page, search for the title of the merch, then get info
16 | - Artist Community
17 |     - Get community posts and things with community posts
18 |         - didnt do it cause it seemed small
19 |         - Have to find an artist that uses community posts and has an active community interaction
20 | - Artist Subscription
21 |     - Im pretty sure artists also have subscriptions
22 | - Label profile picture
23 | - Get Bandcamp Daily tracks from the body
24 |     - The tracks cannot be scraped
25 |     - they are rendered by js
26 |     - maybe someway in the future i can scrape the rendered js


--------------------------------------------------------------------------------
/bandcamp_api/artist.py:
--------------------------------------------------------------------------------
 1 | import requests
 2 | 
 3 | 
 4 | class Artist:
 5 |     def __init__(self, artist_id: int):
 6 |         self.artist_title = ""
 7 |         self.artist_id = 0
 8 |         self.artist_url = ""
 9 |         self.bio = ""
10 |         self.profile_picture_url = ""
11 |         self.location = ""
12 |         self.concerts = []
13 |         self.links = []
14 |         self.album_ids = []
15 | 
16 |         # getting information from api
17 |         response = requests.get(
18 |             url="https://bandcamp.com/api/mobile/25/band_details?band_id=" + str(artist_id),
19 |         )
20 |         result = response.json()
21 |         self.artist_title = result['name']
22 |         self.artist_id = result['id']
23 |         self.artist_url = result['bandcamp_url']
24 |         self.bio = result['bio']
25 |         self.profile_picture_url = "https://f4.bcbits.com/img/" + str(result["bio_image_id"]).zfill(10) + "_0.jpg"
26 |         self.location = result['location']
27 | 
28 |         for show in result["shows"]:
29 |             current_show = {
30 |                 "location": show["loc"],
31 |                 "venue": show["venue"],
32 |                 "date": show["date"],
33 |                 "url": show["uri"],
34 |                 "unix_time": show["utc_date"]
35 |             }
36 | 
37 |             self.concerts.append(current_show)
38 | 
39 |         for link in result["sites"]:
40 |             self.links.append(link["url"])
41 | 
42 |         for album in result["discography"]:
43 |             self.album_ids.append(album["item_id"])
44 | 


--------------------------------------------------------------------------------
/bandcamp_api/bandcampjson.py:
--------------------------------------------------------------------------------
 1 | import logging
 2 | 
 3 | import demjson3
 4 | 
 5 | class BandcampJSON:
 6 |     def __init__(self, body, debugging: bool = False):
 7 |         self.body = body
 8 |         self.json_data = []
 9 | 
10 |         if debugging:
11 |             logging.basicConfig(level=logging.DEBUG)
12 | 
13 |     def generate(self):
14 |         """Grabbing needed data from the page"""
15 |         self.get_pagedata()
16 |         self.get_js()
17 |         return self.json_data
18 | 
19 |     def get_pagedata(self):
20 |         logging.debug(" Grab pagedata JSON..")
21 |         pagedata = self.body.find('div', {'id': 'pagedata'})['data-blob']
22 |         self.json_data.append(pagedata)
23 | 
24 |     def get_js(self):
25 |         """Get <script> element containing the data we need and return the raw JS"""
26 |         logging.debug(" Grabbing embedded scripts..")
27 | 
28 |         embedded_scripts_raw = [self.body.find("script", {"type": "application/ld+json"}).string]
29 |         for script in self.body.find_all('script'):
30 |             try:
31 |                 album_info = script['data-tralbum']
32 |                 embedded_scripts_raw.append(album_info)
33 |             except:
34 |                 continue
35 |         for script in embedded_scripts_raw:
36 |             js_data = self.js_to_json(script)
37 |             self.json_data.append(js_data)
38 | 
39 |     @staticmethod
40 |     def js_to_json(js_data):
41 |         """Convert JavaScript dictionary to JSON"""
42 |         logging.debug(" Converting JS to JSON..")
43 |         # Decode with demjson first to reformat keys and lists
44 |         decoded_js = demjson3.decode(js_data)
45 |         # Encode to make valid JSON, add to list of JSON strings
46 |         encoded_json = demjson3.encode(decoded_js)
47 |         return demjson3.encode(decoded_js)
48 | 


--------------------------------------------------------------------------------
/bandcamp_api/genres.py:
--------------------------------------------------------------------------------
 1 | from .bandcampjson import BandcampJSON
 2 | from bs4 import BeautifulSoup, FeatureNotFound
 3 | import requests
 4 | import logging
 5 | import json
 6 | 
 7 | 
 8 | def get_json(url, debugging: bool = False):
 9 | 
10 |         headers = {'User-Agent': f'bandcamp-api/0 (https://github.com/RustyRin/bandcamp-api)'}
11 | 
12 |         try:
13 |             response = requests.get(url, headers=headers)
14 |         except requests.exceptions.MissingSchema:
15 |             return None
16 | 
17 |         try:
18 |             soup = BeautifulSoup(response.text, "lxml")
19 |         except FeatureNotFound:
20 |             soup = BeautifulSoup(response.text, "html.parser")
21 | 
22 |         logging.debug(" Generating BandcampJSON..")
23 |         bandcamp_json = BandcampJSON(soup, debugging).generate()
24 |         page_json = {}
25 |         for entry in bandcamp_json:
26 |             page_json = {**page_json, **json.loads(entry)}
27 |         logging.debug(" BandcampJSON generated..")
28 | 
29 |         return page_json
30 | 
31 | 
32 | def get_main_genres():
33 |     try:
34 |         page_json = get_json(url="https://intlanthem.bandcamp.com/album/in-these-times")
35 |     except Exception as err:
36 |         print("Error getting the sample album for the genres")
37 |         print(err)
38 |         raise AttributeError
39 | 
40 |     genres = []
41 |     for genre_dict in page_json['signup_params']['genres']:
42 |         genres.append(genre_dict['value'])
43 | 
44 |     return genres
45 | 
46 | 
47 | def get_subgenres(main_genre: str):
48 | 
49 |     if main_genre == "" or main_genre == None:
50 |         raise Exception('Main genre slug was not provided')
51 |     
52 |     try:
53 |         page_json = get_json(url="https://intlanthem.bandcamp.com/album/in-these-times")
54 |     except Exception as err:
55 |         print("Error getting the sample album for the genres")
56 |         print(err)
57 |         raise AttributeError
58 | 
59 |     subgenres = []
60 | 
61 |     for subgenre in  page_json['signup_params']['subgenres'][main_genre]:
62 |         subgenres.append(subgenre['value'])
63 | 
64 |     return subgenres


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | # Byte-compiled / optimized / DLL files
  2 | __pycache__/
  3 | *.py[cod]
  4 | *$py.class
  5 | 
  6 | # C extensions
  7 | *.so
  8 | 
  9 | # Distribution / packaging
 10 | .idea/
 11 | .Python
 12 | build/
 13 | develop-eggs/
 14 | dist/
 15 | downloads/
 16 | eggs/
 17 | .eggs/
 18 | lib/
 19 | lib64/
 20 | parts/
 21 | sdist/
 22 | var/
 23 | wheels/
 24 | pip-wheel-metadata/
 25 | share/python-wheels/
 26 | *.egg-info/
 27 | .installed.cfg
 28 | *.egg
 29 | MANIFEST
 30 | 
 31 | # PyInstaller
 32 | #  Usually these files are written by a python script from a template
 33 | #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 34 | *.manifest
 35 | *.spec
 36 | 
 37 | # Installer logs
 38 | pip-log.txt
 39 | pip-delete-this-directory.txt
 40 | 
 41 | # Unit test / coverage reports
 42 | htmlcov/
 43 | .tox/
 44 | .nox/
 45 | .coverage
 46 | .coverage.*
 47 | .cache
 48 | nosetests.xml
 49 | coverage.xml
 50 | *.cover
 51 | *.py,cover
 52 | .hypothesis/
 53 | .pytest_cache/
 54 | 
 55 | # Translations
 56 | *.mo
 57 | *.pot
 58 | 
 59 | # Django stuff:
 60 | *.log
 61 | local_settings.py
 62 | db.sqlite3
 63 | db.sqlite3-journal
 64 | 
 65 | # Flask stuff:
 66 | instance/
 67 | .webassets-cache
 68 | 
 69 | # Scrapy stuff:
 70 | .scrapy
 71 | 
 72 | # Sphinx documentation
 73 | docs/_build/
 74 | 
 75 | # PyBuilder
 76 | target/
 77 | 
 78 | # Jupyter Notebook
 79 | .ipynb_checkpoints
 80 | 
 81 | # IPython
 82 | profile_default/
 83 | ipython_config.py
 84 | 
 85 | # pyenv
 86 | .python-version
 87 | 
 88 | # pipenv
 89 | #   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
 90 | #   However, in case of collaboration, if having platform-specific dependencies or dependencies
 91 | #   having no cross-platform support, pipenv may install dependencies that don't work, or not
 92 | #   install all needed dependencies.
 93 | #Pipfile.lock
 94 | 
 95 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow
 96 | __pypackages__/
 97 | 
 98 | # Celery stuff
 99 | celerybeat-schedule
100 | celerybeat.pid
101 | 
102 | # SageMath parsed files
103 | *.sage.py
104 | 
105 | # Environments
106 | .env
107 | .venv
108 | env/
109 | venv/
110 | ENV/
111 | env.bak/
112 | venv.bak/
113 | 
114 | # Spyder project settings
115 | .spyderproject
116 | .spyproject
117 | 
118 | # Rope project settings
119 | .ropeproject
120 | 
121 | # mkdocs documentation
122 | /site
123 | 
124 | # mypy
125 | .mypy_cache/
126 | .dmypy.json
127 | dmypy.json
128 | 
129 | # Pyre type checker
130 | .pyre/
131 | .DS_Store
132 | .vscode/settings.json
133 | bandcamp_api/output.json
134 | output.json
135 | /tests/
136 | 


--------------------------------------------------------------------------------
/bandcamp_api/label.py:
--------------------------------------------------------------------------------
 1 | from datetime import datetime
 2 | import time
 3 | import requests
 4 | 
 5 | class Label:
 6 |     def __init__(self, label_id: int | str):
 7 |         self.label_id: int = 0
 8 |         self.label_title: str = ""
 9 |         self.profile_picture_id: int = 0
10 |         self.profile_picture_url: str = ""
11 |         self.url: str = ""
12 |         self.type: str = "label"
13 |         self.bio: str = ""
14 |         self.links: list = []   # list of url strings
15 |         self.albums: list = []
16 |         # {
17 |         #   "album_id": 0123456789,
18 |         #   "album_title": "album_here",
19 |         #   "type": "album",
20 |         #   "artist_id": 0123456789,
21 |         #   "artist_title": "name_here",
22 |         #   "date_released_unix": 0123456789,
23 |         #   "purchasable": True/False
24 |         # }
25 |         self.location: str = ""
26 |         self.artists: list = []
27 | 
28 |         response = requests.get(
29 |             url="https://bandcamp.com/api/mobile/25/band_details?band_id=" + str(label_id),
30 |         )
31 |         result = response.json()
32 | 
33 |         self.label_id = result['id']
34 |         self.label_title = result['name']
35 | 
36 |         self.profile_picture_id = result['bio_image_id']
37 |         self.profile_picture_url = "https://f4.bcbits.com/img/" + str(self.profile_picture_id) + "_0.jpg"
38 | 
39 |         self.url = result['bandcamp_url']
40 |         self.bio = result['bio']
41 | 
42 |         for link in result['sites']:
43 |             self.links.append(link['url'])
44 | 
45 |         for album in result['discography']:
46 |             date_released = album['release_date']
47 |             date_released = datetime.strptime(date_released, '%d %b %Y %H:%M:%S %Z')
48 |             date_released = int(time.mktime(date_released.timetuple()))
49 |             self.albums.append(
50 |                 {
51 |                     "album_id": album['item_id'],
52 |                     "album_title": album['title'],
53 |                     "type": album['item_type'],
54 |                     "artist_id": album['band_id'],
55 |                     "artist_title": album['artist_name'],
56 |                     "date_released_unix": date_released,
57 |                     "purchasable": album["is_purchasable"]
58 |                 }
59 |             )
60 | 
61 |         self.location = result['location']
62 | 
63 |         for artist in result['artists']:
64 |             self.artists.append(
65 |                 {
66 |                     "artist_id": artist['id'],
67 |                     "artist_title": artist['name'],
68 |                     "artist_image_id": artist['image_id'],
69 |                     "artist_image_url": "https://f4.bcbits.com/img/" + str(artist['image_id']) + "_0.jpg",
70 |                     "date_signed": artist['featured_date'],
71 |                     "location": artist['location']
72 |                 }
73 |             )
74 | 


--------------------------------------------------------------------------------
/bandcamp_api/track.py:
--------------------------------------------------------------------------------
  1 | '''
  2 | Need to do
  3 | '''
  4 | from .bandcampjson import BandcampJSON
  5 | import requests
  6 | import logging
  7 | from bs4 import BeautifulSoup, FeatureNotFound
  8 | import json
  9 | from datetime import datetime
 10 | import time
 11 | 
 12 | 
 13 | def get_json(url, debugging: bool = False):
 14 |     header = {'User-Agent': f'bandcamp-api/0 (https://github.com/RustyRin/bandcamp-api)'}
 15 | 
 16 |     try:
 17 |         response = requests.get(url, headers=header)
 18 |     except requests.exceptions.MissingSchema:
 19 |         return None
 20 | 
 21 |     try:
 22 |         soup = BeautifulSoup(response.text, "lxml")
 23 |     except FeatureNotFound:
 24 |         soup = BeautifulSoup(response.text, "html.parser")
 25 | 
 26 |     logging.debug(" Generating JSON...")
 27 | 
 28 |     bandcamp_json = BandcampJSON(soup, debugging).generate()
 29 |     page_json = {}
 30 |     for entry in bandcamp_json:
 31 |         page_json = {**page_json, **json.loads(entry)}
 32 | 
 33 |     logging.debug(' Bandcamp JSON generated...')
 34 | 
 35 |     return page_json
 36 | 
 37 | 
 38 | class Track:
 39 |     def __init__(self, artist_id: int, track_id: int, advanced: bool = False):
 40 | 
 41 |         # object info
 42 |         self.type = "track"
 43 | 
 44 |         # track information
 45 |         self.track_id: int = 0
 46 |         self.track_title: str = ""
 47 |         self.track_number: int = 0
 48 |         self.track_duration_seconds: float = 0.00
 49 |         self.track_streamable: bool = None
 50 |         self.has_lyrics: bool = None
 51 |         self.lyrics: str = ""
 52 |         self.is_price_set: bool = None
 53 |         self.price: dict = {}
 54 |         self.require_email: bool = None
 55 |         self.is_purchasable: bool = None
 56 |         self.is_free: bool = None
 57 |         self.is_preorder: bool = None
 58 |         self.tags: list = []
 59 |         self.track_url: str = ""
 60 | 
 61 |         # art
 62 |         self.art_id: int = 0
 63 |         self.art_url: str = ""
 64 | 
 65 |         # artist information
 66 |         self.artist_id: int = 0
 67 |         self.artist_title: str = ""
 68 | 
 69 |         # album information
 70 |         self.album_id: int = 0
 71 |         self.album_title: str = ""
 72 | 
 73 |         # label
 74 |         self.label_id: int = 0
 75 |         self.label_title: str = ""
 76 | 
 77 |         # about
 78 |         self.about: str = ""
 79 |         self.credits: str = ""
 80 |         self.date_released_unix: int = 0
 81 | 
 82 |         # advanced
 83 |         self.date_last_modified_unix: int = 0
 84 |         self.date_published_unix: int = 0
 85 |         self.supporters: list = []
 86 | 
 87 | 
 88 |         response = requests.get(
 89 |             url="https://bandcamp.com/api/mobile/25/tralbum_details?band_id=" + str(artist_id) +
 90 |                 "&tralbum_id=" + str(track_id) + "&tralbum_type=t"
 91 |         )
 92 |         result = response.json()
 93 |         self.track_id = result['id']
 94 |         self.track_title = result['title']
 95 |         self.track_number = result['tracks'][0]['track_num']
 96 |         self.track_duration_seconds = result['tracks'][0]['duration']
 97 |         self.track_streamable = result['tracks'][0]['is_streamable']
 98 |         self.has_lyrics = result['tracks'][0]['has_lyrics']
 99 | 
100 |         # getting lyrics, if there is any
101 |         if self.has_lyrics is True:
102 |             r = requests.get("https://bandcamp.com/api/mobile/25/tralbum_lyrics?tralbum_id=" + str(self.track_id) + \
103 |                              "&tralbum_type=t")
104 |             rr = r.json()
105 |             self.lyrics = rr['lyrics'][str(self.track_id)]
106 | 
107 |         self.is_price_set = result['is_set_price']
108 |         self.price = {
109 |             "currency": result['currency'],
110 |             "amount": result['price']
111 |         }
112 |         self.require_email = result['require_email']
113 |         self.is_purchasable = result['is_purchasable']
114 |         self.is_free = result['free_download']
115 |         self.is_preorder = result['is_preorder']
116 | 
117 |         for tag in result['tags']:
118 |             self.tags.append(tag['name'])
119 | 
120 |         self.art_id = result['art_id']
121 |         self.art_url = "https://f4.bcbits.com/img/a" + str(self.art_id) + "_0.jpg"
122 | 
123 |         self.artist_id = result['band']['band_id']
124 |         self.artist_title = result['band']['name']
125 | 
126 |         self.album_id = result['album_id']
127 |         self.album_title = result['album_title']
128 | 
129 |         self.label_id = result['label_id']
130 |         self.label_title = result['label']
131 | 
132 |         self.about = result['about']
133 |         self.credits = result['credits']
134 | 
135 |         self.date_released_unix = result['release_date']
136 | 
137 |         self.track_url = result['bandcamp_url']
138 | 
139 |         if advanced:
140 |             try:
141 |                 page_json = get_json(url=self.track_url)
142 |             except:
143 |                 raise FileNotFoundError("Could not get advanced data for track (ID:", self.track_id, ")")
144 | 
145 |             try:
146 |                 self.date_last_modified_unix = datetime.strptime(page_json['dateModified'], '%d %b %Y %H:%M:%S %Z')
147 |                 self.date_last_modified_unix = int(time.mktime(self.date_last_modified_unix.timetuple()))
148 |             except:
149 |                 self.date_last_modified_unix = 0
150 | 
151 |             try:
152 |                 self.date_published_unix = datetime.strptime(page_json['datePublished'], '%d %b %Y %H:%M:%S %Z')
153 |                 self.date_published_unix = int(time.mktime(self.date_published_unix.timetuple()))
154 |             except:
155 |                 self.date_published_unix = 0
156 | 
157 |             try:
158 |                 for supporter in page_json['sponsor']:
159 |                     try:
160 |                         current_supporter = {
161 |                             'username': supporter['name'],
162 |                             'profile_url': supporter['url'],
163 |                             'profile_picture': supporter['image'].split('_')[0] + '_0.jpg'
164 |                         }
165 |                         self.supporters.append(current_supporter)
166 |                     except:
167 |                         pass
168 |             except:
169 |                 pass
170 | 


--------------------------------------------------------------------------------
/bandcamp_api/search.py:
--------------------------------------------------------------------------------
  1 | import requests
  2 | 
  3 | 
  4 | class SearchResultsItemArtist:
  5 | 
  6 |     def __init__(self):
  7 |         self.type = 'artist'
  8 |         self.artist_id = 0
  9 |         self.art_id = 0
 10 |         self.image_id = 0
 11 |         self.artist_title = ""
 12 |         self.location = ""
 13 |         self.is_label = False
 14 |         self.tags = []
 15 |         self.image_url = ""
 16 |         self.genre = ""
 17 |         self.part = ""
 18 |         self.artist_url = ""
 19 |         self.url = ""
 20 | 
 21 | 
 22 | class SearchResultsItemAlbum:
 23 | 
 24 |     def __init__(self):
 25 |         self.type = "album"
 26 |         self.album_id = 0
 27 |         self.art_id = 0
 28 |         self.image_id = 0
 29 |         self.album_title = ""
 30 |         self.artist_id = 0
 31 |         self.artist_title = ""
 32 |         self.image_url = ""
 33 |         self.part = ""
 34 |         self.album_url = ""
 35 |         self.artist_url = ""
 36 |         self.url = ""
 37 | 
 38 | 
 39 | class SearchResultsItemTrack:
 40 | 
 41 |     def __init__(self):
 42 |         self.type = "track"
 43 |         self.track_id = 0
 44 |         self.art_id = 0
 45 |         self.image_id = 0
 46 |         self.track_title = ""
 47 |         self.artist_id = 0
 48 |         self.artist_title = ""
 49 |         self.album_title = ""
 50 |         self.image_url = ""
 51 |         self.album_id = ""
 52 |         self.part = ""
 53 |         self.track_url = ""
 54 |         self.artist_url = ""
 55 |         self.url = ""
 56 | 
 57 | 
 58 | class SearchResultsItemFan:
 59 | 
 60 |     def __init__(self):
 61 |         self.type = "fan"
 62 |         self.fan_id = 0
 63 |         self.art_id = 0
 64 |         self.image_id = 0
 65 |         self.fan_name = ""
 66 |         self.fan_username = ""
 67 |         self.collection_size = 0
 68 |         self.fan_genre = ""
 69 |         self.fan_image = ""
 70 |         self.fan_image_id = ""
 71 |         self.part = ""
 72 |         self.url = ""
 73 | 
 74 | 
 75 | def search(search_string: str = ""):
 76 |     # I got this api url from the iOS app
 77 |     # needs a way of removing characters
 78 |     # that will screw up an url
 79 |     # keep url safe characters
 80 | 
 81 |     response = requests.get(
 82 |         "https://bandcamp.com/api/fuzzysearch/2/app_autocomplete?q=" + search_string + "&param_with_locations=true")
 83 | 
 84 |     results = response.json()['results']
 85 | 
 86 |     return_results = []
 87 | 
 88 |     for item in results:
 89 |         # going item by item
 90 |         if item['type'] == 'b':
 91 |             # For bands and record labels
 92 |             # need to make a try catch for labels
 93 |             # normal bands do not have "artists" element
 94 |             # if it does have it, normal artist, if it does, use label object
 95 |             results_object = SearchResultsItemArtist()
 96 |             results_object.artist_id = item['id']
 97 |             results_object.art_id = item['art_id']
 98 |             results_object.image_id = item['img_id']
 99 |             results_object.artist_title = item['name']
100 |             results_object.location = item['location']
101 |             results_object.is_label = item['is_label']
102 | 
103 |             try:
104 |                 for tag in item['tag_names']:
105 |                     results_object.tags.append(tag)
106 |             except TypeError:
107 |                 pass
108 | 
109 |             results_object.image_url = "https://f4.bcbits.com/img/0000" + str(results_object.image_id) + '_0.png'
110 | 
111 |             # I have seen some bands with no main genre
112 |             try:
113 |                 results_object.genre = item['genre_name']
114 |             except KeyError:
115 |                 pass
116 | 
117 |             # no idea what "part" is
118 |             # it seems to always be "z"
119 |             try:
120 |                 results_object.part = item['part']
121 |             except KeyError:
122 |                 pass
123 | 
124 |             results_object.artist_url = item['url']
125 |             results_object.url = results_object.artist_url
126 | 
127 |             return_results.append(results_object)
128 | 
129 |         elif item['type'] == 'a':
130 |             # album
131 |             results_object = SearchResultsItemAlbum()
132 |             results_object.album_id = item['id']
133 |             results_object.art_id = item['art_id']
134 |             results_object.image_id = item['img_id']
135 |             results_object.album_title = item['name']
136 |             results_object.artist_id = item['band_id']
137 |             results_object.artist_title = item['band_name']
138 |             results_object.image_url = "https://f4.bcbits.com/img/a" + str(item['art_id']) + '_0.png'
139 |             results_object.part = item['part']
140 | 
141 |             # the url given if weird
142 |             # it is in the style of https://bandname.bandcamp.comhttps://bandname.bandcamp.com/album/albumname
143 |             # this should split it
144 |             results_object.artist_url = 'https' + item['url'].split('https')[1]
145 |             results_object.album_url = 'https' + item['url'].split('https')[2]
146 |             results_object.url = results_object.album_url
147 | 
148 |             return_results.append(results_object)
149 | 
150 |         elif item['type'] == 't':
151 |             # track
152 |             results_object = SearchResultsItemTrack()
153 |             results_object.track_id = item['id']
154 |             results_object.art_id = item['art_id']
155 |             results_object.track_title = item['name']
156 |             results_object.artist_id = item['band_id']
157 |             results_object.artist_title = item['band_name']
158 |             results_object.album_title = item['album_name']
159 |             results_object.album_id = item['album_id']
160 |             results_object.image_url = "https://f4.bcbits.com/img/a" + str(item['art_id']) + "_0.png"
161 |             results_object.part = item['part']
162 |             results_object.artist_url = 'https' + item['url'].split('https')[1]
163 |             results_object.track_url = 'https' + item['url'].split('https')[2]
164 |             results_object.url = results_object.track_url
165 | 
166 |             return_results.append(results_object)
167 | 
168 |         elif item['type'] == "f":
169 |             # fan
170 |             results_object = SearchResultsItemFan()
171 |             results_object.fan_id = item['id']
172 |             results_object.art_id = item['art_id']
173 |             results_object.image_id = item['img_id']
174 |             results_object.fan_name = item['name']
175 |             results_object.fan_username = item['username']
176 |             results_object.collection_size = item['collection_size']
177 |             results_object.fan_genre = item['genre_name']
178 |             results_object.fan_image = "https://f4.bcbits.com/img/" + str(item['img_id']) + '_0.png'
179 |             results_object.part = item['part']
180 |             results_object.url = item['url']
181 | 
182 |             return_results.append(results_object)
183 | 
184 |     return return_results
185 | 


--------------------------------------------------------------------------------
/bandcamp_api/bandcamp_api.py:
--------------------------------------------------------------------------------
  1 | from datetime import datetime as dt
  2 | import json
  3 | import logging
  4 | 
  5 | import requests
  6 | from bs4 import BeautifulSoup
  7 | from bs4 import FeatureNotFound
  8 | 
  9 | from .bandcampjson import BandcampJSON
 10 | from .album import Album
 11 | from .artist import Artist
 12 | from .label import Label
 13 | from .daily import Daily, Story
 14 | from .homepage import NewAndNotable, Charts, SaleFeed, BandcampWeekly
 15 | from .genres import get_main_genres, get_subgenres
 16 | from .search import search
 17 | from .track import Track
 18 | 
 19 | def get_json(self, url, debugging: bool = False):
 20 |     try:
 21 |         response = requests.get(url, headers=self.headers)
 22 |     except requests.exceptions.MissingSchema:
 23 |         return None
 24 | 
 25 |     try:
 26 |         self.soup = BeautifulSoup(response.text, "lxml")
 27 |     except FeatureNotFound:
 28 |         self.soup = BeautifulSoup(response.text, "html.parser")
 29 | 
 30 |     logging.debug(" Generating BandcampJSON..")
 31 |     bandcamp_json = BandcampJSON(self.soup, debugging).generate()
 32 |     page_json = {}
 33 |     for entry in bandcamp_json:
 34 |         page_json = {**page_json, **json.loads(entry)}
 35 |     logging.debug(" BandcampJSON generated..")
 36 | 
 37 |     return page_json
 38 | 
 39 | 
 40 | class Bandcamp:
 41 |     def __init__(self):
 42 |         self.headers = {'User-Agent': 'bandcamp-api/0 (https://github.com/RustyRin/bandcamp-api)'}
 43 |         self.soup = None
 44 |         self.tracks = None
 45 | 
 46 |     def get_album(self, album_url: str = None,
 47 |                   album_id: int | str = None,
 48 |                   artist_id: int | str = None,
 49 |                   advanced: bool = False) -> Album | Track:
 50 |         """Returns information for a given album URL"""
 51 |         # split by /album/
 52 |         # take first
 53 | 
 54 |         if album_id is not None and artist_id is not None:
 55 |             return Album(album_id=album_id, artist_id=artist_id, advanced=advanced)
 56 |         else:
 57 |             if '/album/' in album_url:
 58 |                 search_term = album_url.split('/album/')[1]
 59 |             elif '/track/' in album_url:
 60 |                 search_term = album_url.split('/track/')[1]
 61 | 
 62 |             results = search(search_string=search_term.rstrip("//"))
 63 | 
 64 |         for item in results:
 65 |             if item.url == album_url.rstrip('//'):
 66 |                 return Album(album_id=item.album_id, artist_id=item.artist_id, advanced=advanced)
 67 | 
 68 |     def get_track(self, track_url: str, advanced: bool = False) -> Track:
 69 |         """Returns information for a given track URL"""
 70 | 
 71 |         search_term = track_url.split('/track/')[1]
 72 | 
 73 |         results = search(search_string=search_term.rstrip("//"))
 74 | 
 75 |         for item in results:
 76 |             if item.url == track_url.rstrip("//"):
 77 |                 return Track(artist_id=item.artist_id, track_id=item.track_id, advanced=advanced)
 78 | 
 79 |     def get_artist(self, artist_url) -> Artist | Label | None:
 80 |         """Returns information for a given artist URL"""
 81 |         results = search(search_string=artist_url.split(".")[0].split("//")[1])
 82 | 
 83 |         if '/album/' in artist_url:
 84 |             artist_url = artist_url.split('/album')[0]
 85 |         elif '/track/' in artist_url:
 86 |             artist_url = artist_url.split('/track')[0]
 87 |         elif '/music' in artist_url:
 88 |             artist_url = artist_url.split('/music')[0]
 89 | 
 90 |         for item in results:
 91 |             if item.type == "artist" and item.url == artist_url.rstrip("//"):
 92 |                 # checking if it is a label, if it is, use label object
 93 |                 if item.is_label:
 94 |                     return Label(label_id=item.artist_id)
 95 |                 else:
 96 |                     return Artist(artist_id=item.artist_id)
 97 | 
 98 |         return None
 99 | 
100 |     def get_label(self, label_url: str) -> Label | None:
101 |         """Returns information for a given label URL"""
102 |         results = search(search_string=label_url.split(".")[0].split("//")[1])
103 | 
104 |         if '/album/' in label_url:
105 |             label_url = label_url.split('/album')[0]
106 |         elif '/track/' in label_url:
107 |             label_url = label_url.split('/track')[0]
108 | 
109 |         for item in results:
110 |             if item.type == "artist" and item.url == label_url.rstrip("//") and item.is_label:
111 |                 return Label(label_id=item.artist_id)
112 | 
113 |         return None
114 | 
115 |     def daily_latest(self, num_to_get: int):
116 |         """Retuns the latest Bandcamp Daily stories. Warning this is very slow."""
117 |         return Daily().search_latest(num_to_get=num_to_get)
118 | 
119 |     def daily_best_of(self, section_slug: str, num_to_get: int):
120 |         """Returns a list of Bandcamp Daily stories for a given Best Of section"""
121 |         return Daily().search_best_of(section_slug=section_slug, num_to_get=num_to_get)
122 | 
123 |     def daily_franchise(self, section_slug: str, num_to_get: int):
124 |         """Returns a list of Bandcamp Daily stories for a given franchise"""
125 |         return Daily().search_franchises(section_slug=section_slug, num_to_get=num_to_get)
126 | 
127 |     def daily_genre(self, genre_slug: str, num_to_get: int):
128 |         """Returns a list Bandcamp Daily stories for a given genre"""
129 |         return Daily().search_genre(genre_slug=genre_slug, num_to_get=num_to_get)
130 | 
131 |     def daily_get_story(self, story_url: str):
132 |         """Get information on a Bandcamp Daily story"""
133 |         return Story(story_url = story_url)
134 | 
135 |     def new_and_notable(self, num_to_get: int = 5):
136 |         """Returns a list of new and notable releases accoding to Bandcamp"""
137 |         return NewAndNotable(num_to_get)
138 | 
139 |     def get_genres(self):
140 |         """Returns a list of the main overarching genres. For more specific genres see get_subgenres()"""
141 |         # returns a list of main genres
142 |         return get_main_genres()
143 | 
144 |     def get_subgenres(self, main_genre: str = ""):
145 |         """Returns a list of subgenres for a given genre. If no genre is given, all are given
146 |         :param main_genre: Slug of the main genre. See get_genre()."""
147 |         return get_subgenres(main_genre=main_genre)
148 | 
149 |     def charts( self, main_genre: str = "", subgenre: str = "", sort: str = "", format: str = "", page: int = 0):
150 |         """Returns a list of ChartAlbum Objects"""
151 |         return Charts(main_genre=main_genre, subgenre=subgenre, sort=sort, format=format, page=page)
152 | 
153 |     def sales_feed(self):
154 |         """A list of just sold entities."""
155 |         return SaleFeed(self)
156 | 
157 |     def bandcamp_weekly(self, id: int = 0):
158 |         """Returns information about a Bandcamp Weekly release. If no ID is given, assumes latest."""
159 |         return BandcampWeekly.get_show(self, id=id)
160 |     
161 | 
162 |     # doing live streams later
163 |     #def get_live_streams(self):
164 |         """Returns a list of ongoing Bandcamp Livestreams"""
165 | 
166 |     #def get_planned_livestreams(self):
167 |         """Returns a list of planned Bandcamp Livestreams"""
168 |     
169 |     #def get_ongoing_livestreams(self):
170 |         """Returns a list of currently boadcasting livestreams"""
171 | 
172 |     #def get_featured_livestreams(self):
173 |         """Returns a list of Bandcamp featured livestreams"""
174 | 
175 |     def search(self, search_string: str = ""):
176 |         """Fuzzy searches Bandcamp"""
177 |         return search(search_string=search_string)
178 | 
179 |     # def search_artist(self, search_string: str = ""):
180 |     #    """Search Bandcamp for an artist"""
181 |     #    return search_artists(search_string=search_string)
182 | 
183 |     #def search_albums(self, search_string: str = ""):
184 |     #    """Search Bandcamp for an album"""
185 |     #    return search_albums(search_string=search_string)
186 | 
187 |     #def search_tracks(self, search_string: str = ""):
188 |     #    """Search Bandcamp for a track"""
189 |     #    return search_tracks(search_string=search_string)
190 | 
191 |     #def search_fans(self, search_string: str):
192 |     #    """Search Bandcamp for a fan"""
193 |     #    return search_fans(search_string=search_string)


--------------------------------------------------------------------------------
/bandcamp_api/album.py:
--------------------------------------------------------------------------------
  1 | import json
  2 | import requests
  3 | from bs4 import BeautifulSoup
  4 | from bs4 import FeatureNotFound
  5 | from datetime import datetime
  6 | import time
  7 | 
  8 | import logging
  9 | 
 10 | from .bandcampjson import BandcampJSON
 11 | from .track import Track
 12 | 
 13 | 
 14 | class Album:
 15 |     def __init__(self, album_id: str | int, artist_id: str | int, advanced: bool = False):
 16 |         # base album information
 17 |         self.album_title = ""
 18 |         self.album_about = ""
 19 |         self.album_credits = ""
 20 |         self.album_id = 0
 21 |         self.art_id = 0
 22 |         self.art_url = ""
 23 |         self.album_url = ""
 24 |         self.date_released_unix = 0
 25 | 
 26 |         # price
 27 |         self.price = {
 28 |             "currency": None,
 29 |             "amount": None
 30 |         }
 31 |         self.is_free = None
 32 |         self.is_preorder = None
 33 |         self.is_purchasable = None
 34 |         self.is_set_price = None
 35 | 
 36 |         # additional album info
 37 |         self.is_digital = None
 38 |         self.featured_track_id = 0
 39 |         self.record_label_title = ""
 40 |         self.record_label_id = 0
 41 |         self.require_email = None
 42 |         self.tags = []
 43 |         self.total_tracks = 0
 44 |         self.tracks = []
 45 | 
 46 |         self.artist_title = ""
 47 |         self.artist_id = 0
 48 |         self.artist_url = ""
 49 | 
 50 |         self.type = "album"
 51 |         response = requests.get(
 52 |             url="https://bandcamp.com/api/mobile/25/tralbum_details?band_id=" + str(artist_id) +
 53 |             "&tralbum_id=" + str(album_id) + "&tralbum_type=a"
 54 |         )
 55 |         result = response.json()
 56 | 
 57 |         # if it throws an error, that means try as a single
 58 |         try:
 59 |             if "No such tralbum for band" in result['error_message']:
 60 |                 response = requests.get(
 61 |                     url="https://bandcamp.com/api/mobile/25/tralbum_details?band_id=" + str(artist_id) +
 62 |                         "&tralbum_id=" + str(album_id) + "&tralbum_type=t"
 63 |                 )
 64 |                 result = response.json()
 65 |                 self.type = "album-single"
 66 |         except KeyError:
 67 |             pass
 68 | 
 69 |         # general info
 70 |         try:
 71 |             self.album_title = result['album_title']
 72 |             if self.album_title is None:
 73 |                 self.album_title = result['title']
 74 |         except KeyError:
 75 |             # good chance it is a single
 76 |             # parse though track class
 77 |             print("WARNING: Could not load album, trying to load as a track...")
 78 |             self.type = "track"
 79 |             return
 80 | 
 81 |         try:
 82 |             self.album_about = result['about']
 83 |         except KeyError:
 84 |             pass
 85 | 
 86 |         try:
 87 |             self.album_credits = result['credits']
 88 |         except KeyError:
 89 |             pass
 90 | 
 91 |         try:
 92 |             self.album_id = result['id']
 93 |         except KeyError:
 94 |             raise FileNotFoundError('Could not find the album ID. This is either because could not find the album or \
 95 |             it is not an album (such as a track, artist, label, etc. )')
 96 | 
 97 |         try:
 98 |             self.art_id = result['art_id']
 99 |         except KeyError:
100 |             pass
101 | 
102 |         if self.art_id != 0:
103 |             self.art_url = "https://f4.bcbits.com/img/a" + str(self.art_id) + "_0.jpg"
104 | 
105 |         try:
106 |             self.album_url = result['bandcamp_url']
107 |         except KeyError:
108 |             raise FileNotFoundError("Album does not have a URL, this should not happen!")
109 | 
110 |         try:
111 |             self.date_released_unix = result['release_date']
112 |         except KeyError:
113 |             pass
114 | 
115 |         # price info
116 |         try:
117 |             self.price = {
118 |                 "currency": result['currency'],
119 |                 "amount": result['price']
120 |             }
121 |         except KeyError:
122 |             pass
123 | 
124 |         if self.price['amount'] == 0 or self.price['amount'] == 0.0:
125 |             self.is_free = True
126 |         else:
127 |             self.is_free = False
128 | 
129 |         try:
130 |             self.is_preorder = result['is_preorder']
131 |         except KeyError:
132 |             pass
133 | 
134 |         try:
135 |             self.is_purchasable = result['is_purchasable']
136 |         except KeyError:
137 |             pass
138 | 
139 |         try:
140 |             self.is_set_price = result['is_set_price']
141 |         except KeyError:
142 |             pass
143 | 
144 |         # additional album info
145 |         try:
146 |             self.is_digital = result['has_digital_download']
147 |         except KeyError:
148 |             pass
149 | 
150 |         try:
151 |             self.featured_track_id = result['featured_track_id']
152 |         except KeyError:
153 |             pass
154 | 
155 |         try:
156 |             self.record_label_title = result['label']
157 |         except KeyError:
158 |             pass
159 | 
160 |         try:
161 |             self.record_label_id = result['label_id']
162 |         except KeyError:
163 |             pass
164 | 
165 |         try:
166 |             self.require_email = result['require_email']
167 |         except KeyError:
168 |             pass
169 | 
170 |         try:
171 |             for tag in result['tags']:
172 |                 self.tags.append(tag['name'])
173 |         except KeyError:
174 |             pass
175 | 
176 |         try:
177 |             self.total_tracks = result['num_downloadable_tracks']
178 |         except KeyError:
179 |             pass
180 | 
181 |         try:
182 |             self.artist_title = result['tralbum_artist']
183 |         except KeyError:
184 |             pass
185 | 
186 |         try:
187 |             self.artist_id = result['band']['band_id']
188 |         except KeyError:
189 |             pass
190 | 
191 |         try:
192 |             self.artist_url = self.album_url.split("album")[0]
193 |         except KeyError:
194 |             pass
195 | 
196 |         for track in result['tracks']:
197 |             self.tracks.append(Track(artist_id=self.artist_id, track_id=track['track_id'], advanced=advanced))
198 | 
199 |         # advanced scraping
200 |         # the api as i understand it, does not have a way for things like copyright, reviews, supporters
201 |         # to get these, going to use the web scraper method
202 |         # as this is basically legacy code, it will be slightly worse c:
203 | 
204 |         if advanced is True:
205 |             try:
206 |                 page_json = get_json(url=self.album_url)
207 |             except:
208 |                 raise AttributeError("Error finding needed information. Either album is private/ \
209 |                 gone, or the link is malformed")
210 | 
211 |             try:
212 |                 self.copyright = page_json['copyrightNotice']
213 |             except KeyError:
214 |                 self.copyright = ""
215 | 
216 |             self.reviews = []
217 |             try:
218 |                 for review in page_json['comment']:
219 |                     current_review = {}
220 | 
221 |                     try:
222 |                         current_review["username"] = str(review['author']['name'])
223 |                         current_review['username'] = ' '.join(current_review["username"].split())
224 |                     except:
225 |                         current_review["username"] = ""
226 | 
227 |                     try:
228 |                         current_review['profile_url'] = review['author']['url']
229 |                     except:
230 |                         current_review['profile_url'] = ""
231 | 
232 |                     try:
233 |                         current_review['profile_picture'] = review['author']['image']
234 |                         current_review['profile_picture'] = current_review['profile_picture'].split('_')[0] + '_0.jpg'
235 |                     except:
236 |                         current_review['profile_picture']  = ""
237 | 
238 |                     try:
239 |                         current_review['review'] = str(review['text'][0])
240 |                         current_review['review'] = ' '.join(current_review['review'].split())
241 |                     except:
242 |                         current_review['review'] = ""
243 | 
244 |                     try:
245 |                         current_review['favorite_track'] = str(review['text'][1].split(": ")[1])
246 |                     except:
247 |                         current_review['favorite_track'] = ""
248 | 
249 |                     self.reviews.append(current_review)
250 |             except:
251 |                 pass
252 | 
253 |             self.supporters = []
254 |             try:
255 |                 for supporter in page_json['sponsor']:
256 |                     try:
257 |                         current_supporter = {
258 |                             'username': supporter['name'],
259 |                             'profile_url': supporter['url'],
260 |                             'profile_picture': supporter['image'].split('_')[0] + '_0.jpg'
261 |                         }
262 |                         self.supporters.append(current_supporter)
263 |                     except:
264 |                         pass
265 |             except:
266 |                 pass
267 | 
268 | 
269 | def get_album(album_id: int = None):
270 |     """With a given album ID and artist ID, get available information"""
271 | 
272 |     response = requests.get(
273 |         url="https://bandcamp.com/api/mobile/25/tralbum_details",
274 |         headers={"tralbum_id": str(id)}
275 |     )
276 | 
277 | 
278 | def get_json(url, debugging: bool = False):
279 | 
280 |     headers = {'User-Agent': f'bandcamp-api/0 (https://github.com/RustyRin/bandcamp-api)'}
281 | 
282 |     try:
283 |         response = requests.get(url, headers=headers)
284 |     except requests.exceptions.MissingSchema:
285 |         return None
286 | 
287 |     try:
288 |         soup = BeautifulSoup(response.text, "lxml")
289 |     except FeatureNotFound:
290 |         soup = BeautifulSoup(response.text, "html.parser")
291 | 
292 |     logging.debug(" Generating BandcampJSON..")
293 |     bandcamp_json = BandcampJSON(soup, debugging).generate()
294 |     page_json = {}
295 |     for entry in bandcamp_json:
296 |         page_json = {**page_json, **json.loads(entry)}
297 |     logging.debug(" BandcampJSON generated..")
298 | 
299 |     return page_json
300 | 


--------------------------------------------------------------------------------
/bandcamp_api/daily.py:
--------------------------------------------------------------------------------
  1 | import requests
  2 | from bs4 import BeautifulSoup, FeatureNotFound
  3 | import logging
  4 | import json
  5 | from .bandcampjson import BandcampJSON
  6 | from datetime import datetime
  7 | import time
  8 | 
  9 | def string_clean(input_string):
 10 |     return ' '.join(input_string.split())
 11 | 
 12 | class Daily():
 13 |     def __init__(Bandcamp):
 14 |        """Bandcamp Daily"""
 15 | 
 16 |     def search_latest(self, num_to_get: int):
 17 |         """Gets the latests stories form the Bandcamp Daily
 18 |         :param num_to_get: The number of BCDaily posts to return. Will allways return an array of article links."""
 19 |         page = 1
 20 |         url = "https://daily.bandcamp.com/latest?page="
 21 |         posts_obtained = []
 22 |         header = {'User-Agent': 'bandcamp-api/0 (https://github.com/RustyRin/bandcamp-api)'}
 23 |         while True:
 24 |             try:
 25 |                 response = requests.get(url=url + str(page), headers=header)
 26 |             except requests.exceptions.MissingSchema as Err:
 27 |                 return Err
 28 |             
 29 |             try:
 30 |                 soup = BeautifulSoup(response.text, "lxml")
 31 |             except FeatureNotFound:
 32 |                 soup = BeautifulSoup(response.text, "html.parser")
 33 | 
 34 |             articles = soup.find("articles-list")
 35 |             try:
 36 |                 articles = articles.find_all('div', {"class": "title-wrapper"})
 37 |                 #list = []
 38 | 
 39 |                 for article in articles:
 40 |                     if len(posts_obtained) < num_to_get:
 41 |                         posts_obtained.append("https://daily.bandcamp.com" + article.find('a').get('href'))
 42 |                     else:
 43 |                         return posts_obtained
 44 |             except:
 45 |                 return posts_obtained
 46 | 
 47 |             page += 1
 48 | 
 49 |     def search_best_of(self, section_slug: str, num_to_get: int):
 50 |         """Seach for BCDaily posts in the Best Of section.
 51 |         :param section_slug: The URL slug of the section you want. Example for Best of 2016: 'best-of-2016'
 52 |         :param num_to_get: The number of BCDaily posts to return. Will allways return an array of article links."""
 53 |         header = {'User-Agent': 'bandcamp-api/0 (https://github.com/RustyRin/bandcamp-api)'}
 54 |         url = "https://daily.bandcamp.com/"
 55 |         page = 1
 56 |         posts_obtained = []
 57 | 
 58 |         while True:
 59 |             try:
 60 |                 response = requests.get(url=url + section_slug  + '?page=' + str(page), headers=header)
 61 |             except requests.exceptions.MissingSchema:
 62 |                 return ""
 63 |             
 64 |             try:
 65 |                 soup = BeautifulSoup(response.text, "lxml")
 66 |             except FeatureNotFound:
 67 |                 soup = BeautifulSoup(response.text, "html.parser")
 68 | 
 69 |             articles = soup.find("articles-list")
 70 |             try:
 71 |                 articles = articles.find_all('div', {"class": "title-wrapper"})
 72 | 
 73 |                 for article in articles:
 74 |                     if len(posts_obtained) < num_to_get:
 75 |                         posts_obtained.append("https://daily.bandcamp.com" + article.find('a').get('href'))
 76 |                     else:
 77 |                         return posts_obtained
 78 |             except:
 79 |                 return posts_obtained
 80 | 
 81 |             page += 1
 82 |             print("Going to page " + str(page))
 83 |                 
 84 | 
 85 | 
 86 | 
 87 |     def search_franchises(self, section_slug: str, num_to_get: int):
 88 |         """Seach the BCDaily in the Franchises section.
 89 |         :param section_slug: The URL slug of the section you want. Example for Album Of The Day: album-of-the-day
 90 |         :param num_to_get: The number of BCDaily posts to return. Will allways return an array of article links."""
 91 |         header = {'User-Agent': 'bandcamp-api/0 (https://github.com/RustyRin/bandcamp-api)'}
 92 |         url = "https://daily.bandcamp.com/"
 93 |         page = 1
 94 |         posts_obtained = []
 95 | 
 96 |         while True:
 97 |             try:
 98 |                 response = requests.get(url=url + section_slug  + '?page=' + str(page), headers=header)
 99 |             except requests.exceptions.MissingSchema:
100 |                 return ""
101 |             
102 |             try:
103 |                 soup = BeautifulSoup(response.text, "lxml")
104 |             except FeatureNotFound:
105 |                 soup = BeautifulSoup(response.text, "html.parser")
106 | 
107 |             articles = soup.find("articles-list")
108 |             try:
109 |                 articles = articles.find_all('div', {"class": "title-wrapper"})
110 | 
111 |                 for article in articles:
112 |                     if len(posts_obtained) < num_to_get:
113 |                         posts_obtained.append("https://daily.bandcamp.com" + article.find('a').get('href'))
114 |                     else:
115 |                         return posts_obtained
116 |             except:
117 |                 return posts_obtained
118 | 
119 |             page += 1
120 | 
121 |     def search_genre(self, genre_slug: str, num_to_get: int):
122 |         """Search the BCDail in the Genre section.
123 |         :param genre_slug: The URL slug of the genre you want. Example for R&B/Soul: r-b-soul
124 |         :param num_to_get: The number of BCDaily posts to return. Will allways return an array of article links."""
125 |         header = {'User-Agent': 'bandcamp-api/0 (https://github.com/RustyRin/bandcamp-api)'}
126 |         url = "https://daily.bandcamp.com/genres/"
127 |         page = 1
128 |         posts_obtained = []
129 | 
130 |         while True:
131 |             try:
132 |                 response = requests.get(url=url + genre_slug  + '?page=' + str(page), headers=header)
133 |             except requests.exceptions.MissingSchema:
134 |                 return ""
135 |             
136 |             try:
137 |                 soup = BeautifulSoup(response.text, "lxml")
138 |             except FeatureNotFound:
139 |                 soup = BeautifulSoup(response.text, "html.parser")
140 | 
141 |             try:
142 |                 articles = soup.find("articles-list")
143 |                 articles = articles.find_all('div', {"class": "title-wrapper"})
144 |                 list = []
145 | 
146 |                 for article in articles:
147 |                     if len(posts_obtained) < num_to_get:
148 |                         posts_obtained.append("https://daily.bandcamp.com/genres" + article.find('a').get('href'))
149 |                     else:
150 |                         return posts_obtained
151 |             except:
152 |                 return posts_obtained
153 | 
154 |             page += 1        
155 | 
156 | def get_json(url, debugging: bool = False):
157 | 
158 |     header = {'User-Agent': f'bandcamp-api/0 (https://github.com/RustyRin/bandcamp-api)'}
159 | 
160 |     try:
161 |         response = requests.get(url, headers=header)
162 |     except requests.exceptions.MissingSchema:
163 |         return ""
164 |     
165 |     try:
166 |         soup = BeautifulSoup(response.text, "lxml")
167 |     except FeatureNotFound:
168 |         soup = BeautifulSoup(response.text, "html.parser")
169 | 
170 |     logging.debug(" Generating JSON...")
171 | 
172 |     bandcamp_json = BandcampJSON(soup, debugging).generate()
173 |     page_json = {}
174 |     for entry in bandcamp_json:
175 |         page_json = {**page_json, **json.loads(entry)}
176 | 
177 |     logging.debug(' Bandcamp JSON generated...')
178 | 
179 |     return page_json
180 | 
181 | class Story():
182 |     def __init__(self, story_url: str):
183 |         self.title = ""
184 |         self.author = ""
185 |         self.description = ""
186 |         self.headline = ""
187 |         self.main_image_url = ""
188 |         self.story_type = ""
189 |         self.linked_in_text = []
190 |         self.linked_media = []
191 |         self.text = ""
192 |         self.date_published = 0
193 |         self.date_last_modified = 0
194 |         self.images = []        # look for story with multiple images
195 |         self.tags = []
196 | 
197 |         response = requests.get(story_url)
198 | 
199 |         try:
200 |             page_json = get_json(url = story_url)
201 |         except Exception as err:
202 |             print(err)
203 |             raise AttributeError("Either the Artist URL gicen is either private, deleted or the link is malformed")
204 |         
205 |         try:
206 |             soup = BeautifulSoup(response.text, "lxml")
207 |         except FeatureNotFound:
208 |             soup = BeautifulSoup(response.text, "html.parser")
209 |         
210 |         try:
211 |             soup = BeautifulSoup(response.text, "lxml")
212 |         except FeatureNotFound:
213 |             soup = BeautifulSoup(response.text, "html5lib")
214 | 
215 |         self.title = string_clean(soup.find('article-title').text)
216 | 
217 |         self.author = soup.find('article-credits')
218 |         self.author = string_clean(self.author.find('a').text)
219 | 
220 |         self.story_type = string_clean(soup.find('article-type').text.lower())
221 |         body = soup.find('article')
222 |         body = body.find_all('p')
223 | 
224 |         for section in body:
225 |             for link in section.find_all('a'):
226 |                 #self.linked_in_text.append(link.absolute_links.pop())
227 |                 self.linked_in_text.append(link.get('href'))
228 |             if string_clean(section.text):
229 |                 self.text = self.text + string_clean(section.text) + '\n\n'                
230 | 
231 |         players = soup.find_all("div", {"class": "player-wrapper"})
232 | 
233 | 
234 |         '''
235 |         I wanted to make a thing
236 |         to get songs that were featured
237 |         in a BCD story, but a large amount
238 |         of the information is rendered
239 |         in JS, I tried to get it with
240 |         requests-html and its render
241 |         funtion but could not get it
242 |         to work propery. Sorry.
243 |         '''
244 | 
245 |         try:
246 |             self.date_published = datetime.strptime(page_json['datePublished'], '%Y-%m-%dT%H:%M:%SZ')
247 |             self.date_published = int(time.mktime(self.date_published.timetuple()))
248 |         except:
249 |             self.published = 0
250 | 
251 |         try:
252 |             self.date_last_modified = datetime.strptime(page_json['dateModified'], '%Y-%m-%dT%H:%M:%SZ')
253 |             self.date_last_modified = int(time.mktime(self.advanced['last_edited'].timetuple()))
254 |         except:
255 |             self.date_last_modified = self.date_published
256 | 
257 |         self.description = page_json['description']
258 | 
259 |         self.headline = page_json['headline']
260 | 
261 |         self.main_image_url = page_json['image']
262 | 
263 |         '''
264 |         bandcamp does not seem to have a standard way
265 |         to deal with images
266 |         sometimes its in a gallery class
267 |         sometimes its in an inline class
268 |         sometimes its just laying there
269 | 
270 |         so i am loading the entire article body
271 |         then deleting all music, artist and merch
272 |         that is all on the side
273 |         '''
274 |         body = soup.find('article')
275 | 
276 |         artists = body.find_all("mplayer-artist")       # artists
277 |         for artist in artists:
278 |             artist.decompose()
279 |         players = body.find_all('mplayer')              # players
280 |         for player in players:
281 |             player.decompose()
282 |         all_merch = body.find_all('mplayer-sidebar')    # merch
283 |         for merch in all_merch:
284 |             merch.decompose()
285 | 
286 |         for photo in body.find_all('img'):
287 |             if photo.get('src') is not None:
288 |                 self.images.append(photo.get('src'))
289 | 
290 |         self.tags = page_json['keywords'].split(', ')
291 | 


--------------------------------------------------------------------------------
/bandcamp_api/homepage.py:
--------------------------------------------------------------------------------
  1 | import requests
  2 | from bs4 import BeautifulSoup, FeatureNotFound
  3 | import json
  4 | import random
  5 | import logging
  6 | from .bandcampjson import BandcampJSON
  7 | from datetime import datetime
  8 | import time
  9 | 
 10 | 
 11 | def get_json(url, debugging: bool = False):
 12 | 
 13 |     header = {'User-Agent': f'bandcamp-api/0 (https://github.com/RustyRin/bandcamp-api)'}
 14 | 
 15 |     try:
 16 |         response = requests.get(url, headers=header)
 17 |     except requests.exceptions.MissingSchema:
 18 |         return None
 19 |     
 20 |     try:
 21 |         soup = BeautifulSoup(response.text, "lxml")
 22 |     except FeatureNotFound:
 23 |         soup = BeautifulSoup(response.text, "html.parser")
 24 | 
 25 |     logging.debug(" Generating JSON...")
 26 | 
 27 |     bandcamp_json = BandcampJSON(soup, debugging).generate()
 28 |     page_json = {}
 29 |     for entry in bandcamp_json:
 30 |         page_json = {**page_json, **json.loads(entry)}
 31 | 
 32 |     logging.debug(' Bandcamp JSON generated...')
 33 | 
 34 |     return page_json
 35 | 
 36 | 
 37 | def get_current_new_and_notable_id():
 38 |     ping_size = 7          # how many guesses should be do per get/ping, max 60
 39 |     check_width = 7        # how many future IDs should be checked if they exist
 40 |     highest_known = 1835    # the highest number that got a response
 41 |     lowest_unknown = 999999      # the lowest seen number that got a response
 42 |     latest_id = None
 43 | 
 44 |     still_looking = True
 45 | 
 46 |     while still_looking:
 47 | 
 48 |         currently_guessing = []
 49 | 
 50 |         try:
 51 |             currently_guessing = random.sample(range(highest_known, lowest_unknown), ping_size)
 52 |         except:
 53 |             currently_guessing = random.sample(range(highest_known - check_width, lowest_unknown + check_width), ping_size)
 54 | 
 55 |         # get information
 56 |         id_string = ''
 57 |         for id in currently_guessing:
 58 |             id_string += str(id) + ','
 59 |         r = requests.get('https://bandcamp.com/api/notabletralbum/2/get?id=' + id_string)
 60 | 
 61 |         # see what becomes valid and invalid
 62 |         results = r.json()
 63 | 
 64 |         # for each guess, get next check_width entry ids
 65 |         for id in currently_guessing:
 66 |             # make check
 67 |             check_string = ''
 68 |             for i in range(check_width - 1):
 69 |                 check_string += str(id + i) + ','
 70 | 
 71 |             check = requests.get('https://bandcamp.com/api/notabletralbum/2/get?id=' + check_string)
 72 |             check = check.json()
 73 |             
 74 |             # if a single one returns then it is the new highest known
 75 |             if check != {}:
 76 |                 # it is not empty
 77 |                 if len(check) == 1:
 78 |                     still_looking = False
 79 |                     latest_id = id
 80 |                     break
 81 |                 if id > highest_known:
 82 |                     highest_known = id
 83 |             else:
 84 |                 # it is empty
 85 |                 if id < lowest_unknown:
 86 |                     lowest_unknown = id
 87 | 
 88 |     return latest_id
 89 | 
 90 | 
 91 | class NewAndNotable():
 92 | 
 93 |     def __init__(self, num_to_get: int = 5):
 94 |         self.albums = []
 95 | 
 96 |         current_id = get_current_new_and_notable_id()
 97 |         #ids = []
 98 |         id_string = ''
 99 | 
100 |         for i in range(num_to_get):
101 |             id_string += (str(current_id - i)) + ','
102 | 
103 |         entries = requests.get('https://bandcamp.com/api/notabletralbum/2/get?id=' + id_string)
104 |         entries = entries.json()
105 | 
106 |         for key in entries:
107 |             album = NewAndNotableAlbum()
108 |             entry = {}
109 |             entry = entries[str(key)]
110 | 
111 |             album.album_artist = entry['artist']
112 | 
113 |             album.album_title = entry['title']
114 | 
115 |             album.album_art = "https://f4.bcbits.com/img/a" + str(entry['art_id']) + "_0"
116 | 
117 |             album.album_url = entry['tralbum_url']
118 | 
119 |             album.genre = entry['genre']
120 | 
121 |             album.date_published = datetime.strptime(entry['published_date'], '%d %b %Y %H:%M:%S %Z')
122 |             album.date_published = int(time.mktime(album.date_published.timetuple()))
123 | 
124 |             album.date_last_modified = datetime.strptime(entry['mod_date'], '%d %b %Y %H:%M:%S %Z')
125 |             album.date_last_modified = int(time.mktime(album.date_last_modified.timetuple()))
126 | 
127 |             album.description = entry['desc']
128 | 
129 |             album.advanced['band_id'] = entry['band_id']
130 |             album.advanced['album_id'] = entry['tralbum_id']
131 |             album.advanced['art_id'] = entry['art_id']
132 |             album.advanced['featured_track_id'] = entry['featured_track_id']
133 | 
134 |             self.albums.append(album)
135 | 
136 | 
137 | class NewAndNotableAlbum():
138 |     def __init__(self):
139 | 
140 |         self.album_artist = ""
141 |         self.album_title = ""
142 |         self.album_art = ""
143 |         self.album_url = ""
144 |         self.genre = ""
145 |         self.date_published = 0
146 |         self.date_last_modified = 0
147 |         self.description = ""
148 |         self.advanced = {}
149 | 
150 |         
151 | class Charts:
152 |     def __init__(
153 |             self,
154 |             main_genre: str = "all",
155 |             sort: str = "top",
156 |             page: int = 0,
157 |             format: str = 'all',
158 |             subgenre: str = ""):
159 | 
160 |         self.albums = []
161 | 
162 |         if not main_genre:
163 |             main_genre = "all"
164 | 
165 |         if not sort:
166 |             sort = 'top'
167 | 
168 |         if page is None or not page:
169 |             page = 0
170 | 
171 |         if not format:
172 |             format = 'all'
173 | 
174 |         if not subgenre:
175 |             subgenre = ""
176 | 
177 |         arg_string = ""
178 | 
179 |         arg_string += 'g=' + main_genre
180 | 
181 |         arg_string += '&s=' + sort
182 | 
183 |         if main_genre != 'all' and ('rec' not in sort):
184 |             # can contain subgenre
185 |             arg_string += '&t=' + subgenre
186 | 
187 |         if 'rec' not in sort:
188 |             # can contain format
189 |             arg_string += '&f=' + format
190 |         else:
191 |             # there is a artist rec filter
192 |             # well which one
193 |             # most or latest
194 |             if 'most' in sort:
195 |                 arg_string += '&r=most'
196 |             else:
197 |                 arg_string += '&r=latest'
198 | 
199 |         arg_string += '&p=' + str(page)
200 |         
201 |         r = requests.get('https://bandcamp.com/api/discover/3/get_web?' + arg_string)
202 |         r = r.json()
203 | 
204 |         for current_album in r['items']:
205 |             album = ChartsAlbum()
206 | 
207 |             album.album_artist = current_album['secondary_text']
208 | 
209 |             album.album_title = current_album['primary_text']
210 | 
211 |             if current_album['url_hints']['custom_domain'] not in ['null', 'Null', 'None']:
212 |                 album.artist_url = 'https://' + current_album['url_hints']['subdomain'] + '.bandcamp.com'
213 |             else:
214 |                 album.artist_url = current_album['url_hints']['custom_domain']
215 | 
216 |             if current_album['url_hints']['item_type'] == 'a':
217 |                 album.album_url = album.artist_url + '/album/' + current_album['url_hints']['slug']
218 |             else:
219 |                 album.album_url = album.artist_url + '/track/' + current_album['url_hints']['slug']
220 | 
221 |             album.genre = current_album['genre_text']
222 | 
223 |             if current_album['location_text'] not in ['null', 'Null', "none", "None"] and current_album['location_text'] is not None:
224 |                 album.artist_location = current_album['location_text']
225 |             else:
226 |                 album.artist_location = ""
227 | 
228 |             album.date_published = datetime.strptime(current_album['publish_date'], '%d %b %Y %H:%M:%S %Z')
229 |             album.date_published = int(time.mktime(album.date_published.timetuple()))
230 | 
231 |             album.featured_track = {
232 |                 "title": current_album['featured_track']['title'],
233 |                 "id": current_album['featured_track']['id'],
234 |                 "duration": current_album['featured_track']['duration']
235 |             }
236 | 
237 |             album.advanced = {
238 |                 "band_id": current_album['band_id'],
239 |                 "album_id": current_album['id'],
240 |                 "art_id": current_album['art_id'],
241 |                 "bio_image_id": current_album['bio_image']['image_id']
242 |             }
243 | 
244 |             self.albums.append(album)
245 | 
246 | 
247 | class ChartsAlbum:
248 |     def __init__(self):
249 |         self.album_artist = ""
250 |         self.album_title = ""
251 |         self.artist_url = ""
252 |         self.album_url = ""
253 |         self.genre = ""
254 |         self.artist_location = ""
255 |         self.date_published = 0
256 |         self.featured_track = {}
257 |         self.advanced = {}
258 | 
259 | 
260 | class SaleFeed:
261 |     def __init__(self, time: int = 0):
262 | 
263 |         self.sold_time = 0.00000
264 |         #self.artist = ""
265 |         self.purchases = []
266 |         if time == 0:
267 |             # looks like they didnt give a start time
268 |             # assume they just want the whatever the latest is
269 |             r = requests.get('https://bandcamp.com/api/salesfeed/1/get')
270 |         else:
271 |             r = requests.get('https://bandcamp.com/api/salesfeed/1/get?start_date=' + str(time))
272 | 
273 |         r = r.json()
274 |         for sale in r['events']:
275 | 
276 |             bought_items = []
277 | 
278 |             self.sold_time = sale['utc_date']
279 | 
280 |             for current_item in sale['items']:
281 |                 # because you can buy multiple items
282 |                 item = Item()
283 | 
284 |                 item.price = {
285 |                     "currency": current_item['currency'],
286 |                     "price": current_item['item_price'],
287 |                     "paid": current_item['amount_paid']
288 |                 }
289 | 
290 |                 item.description = current_item['item_description']
291 | 
292 |                 item.url = 'https:' + current_item['url']
293 | 
294 |                 if current_item['slug_type'] == 'a':
295 |                     item.type = 'album'
296 |                 elif current_item['slug_type'] == 't':
297 |                     item.type = 'track'
298 |                 elif current_item['slug_type'] == 'b':
299 |                     item.type = 'discography'
300 |                 else:
301 |                     item.type = 'physical'
302 | 
303 |                 if item.type == 'physical':
304 |                     item.image_url = "https://f4.bcbits.com/img/" + str(current_item['package_image_id']) +"_0.jpg"
305 |                 else:
306 |                     item.image_url = "https://f4.bcbits.com/img/a" + str(current_item['art_id']) +"_0.jpg"
307 |                 bought_items.append(item)
308 | 
309 |             self.purchases.append(bought_items)
310 | 
311 |         
312 | class Item:
313 |     def __init__(self):
314 |         self.price = {}
315 |         # {
316 |         #   "price": 0.00,
317 |         #   "paid": 0.00,
318 |         #   "currency": "USD"
319 |         # }
320 |         self.image_url = ""
321 | 
322 |         self.description = ""
323 | 
324 |         self.type = ""
325 |         # t for track
326 |         # p seems to be for physical
327 |         # a for album
328 |         # b is full disco
329 | 
330 |         self.url = ""
331 | 
332 | 
333 | class BandcampWeekly():
334 | 
335 |     def __init__(self):
336 | 
337 |         # time
338 |         self.date_released = 0
339 |         self.date_published = 0
340 | 
341 |         # image
342 |         self.image_url = ""
343 | 
344 |         # audio
345 |         self.stream_url = ""
346 |         self.duration_seconds = 0.00
347 | 
348 |         # episode
349 |         self.episode_title = ""
350 |         self.series_title = "" # Normal BCW or the hipho show
351 |         self.episode_description_long = ""
352 |         self.episode_description_short = ""
353 |         self.episode_subtitle = ""
354 |         self.episode_id = 0
355 | 
356 |         # tracks
357 |         self.tracks = []
358 | 
359 |     def get_show(self, id: int):
360 |         if id == 0:
361 |             r = requests.get('https://bandcamp.com/api/bcweekly/3/list')
362 |             r = r.json()
363 |             id = r['results'][0]['id']
364 |         
365 |         r = requests.get("https://bandcamp.com/api/bcweekly/2/get?id=" + str(id))
366 |         r = r.json()
367 | 
368 |         self.date_released = datetime.strptime(r['date'], '%d %b %Y %H:%M:%S %Z')
369 |         self.date_released = int(time.mktime(self.date_released.timetuple()))
370 | 
371 |         self.date_published = datetime.strptime(r['published_date'], '%d %b %Y %H:%M:%S %Z')
372 |         self.date_published = int(time.mktime(self.date_published.timetuple()))
373 | 
374 |         self.image_url = "https://f4.bcbits.com/img/" + str(r['show_image_id']) + '_0.jpg'
375 | 
376 |         self.stream_url = r['audio_stream']['mp3-128']
377 | 
378 |         self.duration_seconds = r['audio_duration']
379 | 
380 |         self.episode_title = r['audio_title']
381 |         self.series_title = r['title']
382 |         self.episode_description_long = r['desc']
383 |         self.episode_description_short = r['short_desc']
384 |         self.episode_subtitle = r['subtitle']
385 |         self.episode_id = r['show_id']
386 |         self.tracks = []
387 | 
388 |         for track in r['tracks']:
389 |             track_object = BandcampWeeklyTrack()
390 | 
391 |             if track['label'] != None:
392 |                 track_object.label_title = track['label']
393 | 
394 |             try:
395 |                 track_object.art_url = "https://f4.bcbits.com/img/a" + str(track['track_art_id']) + "_0.jpg"
396 |             except:
397 |                 pass
398 |             
399 |             try:
400 |                 if track['album_title'] != None:
401 |                     track_object.album_title = track['album_title']
402 |                 else:
403 |                     track_object.album_title = track['title']
404 |             except:
405 |                 pass
406 | 
407 |             track_object.price = {
408 |                 "currency": track['currency'],
409 |                 "amount": track['price']
410 |             }
411 |             if '/album/' in track['url']:
412 |                 track_object.artist_url = track['url'].split('/album/')[0]
413 |                 track_object.album_title = track['album_title']
414 |             else:
415 |                 track_object.artist_url = track['url'].split('/track/')[0]
416 | 
417 |             try:
418 |                 track_object.album_url = track['album_url']
419 |             except:
420 |                 pass
421 | 
422 |             track_object.track_url = track['track_url']
423 |             track_object.track_title = track['title']
424 |             track_object.artist_title = track['artist']
425 | 
426 |             try:
427 |                 track_object.location = track['location_text']
428 |             except:
429 |                 pass
430 |             
431 |             track_object.start_timecode = track['timecode']
432 | 
433 |             self.tracks.append(track_object)
434 | 
435 |         return self
436 | 
437 | 
438 | class BandcampWeeklyTrack():
439 | 
440 |     def __init__(self):
441 |         self.art_url = ""
442 |         self.album_title = ""
443 |         self.label_title = ""
444 |         self.price = {}
445 |             # "currency": "USD",
446 |             # "amount": 0.00
447 |         self.artist_url = ""
448 |         self.album_url = ""
449 |         self.track_url = ""
450 |         self.track_title = ""
451 |         self.artist_title = ""
452 |         self.location = ""
453 |         self.start_timecode = 0
454 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU GENERAL PUBLIC LICENSE
  2 |                        Version 3, 29 June 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  5 |  Everyone is permitted to copy and distribute verbatim copies
  6 |  of this license document, but changing it is not allowed.
  7 | 
  8 |                             Preamble
  9 | 
 10 |   The GNU General Public License is a free, copyleft license for
 11 | software and other kinds of works.
 12 | 
 13 |   The licenses for most software and other practical works are designed
 14 | to take away your freedom to share and change the works.  By contrast,
 15 | the GNU General Public License is intended to guarantee your freedom to
 16 | share and change all versions of a program--to make sure it remains free
 17 | software for all its users.  We, the Free Software Foundation, use the
 18 | GNU General Public License for most of our software; it applies also to
 19 | any other work released this way by its authors.  You can apply it to
 20 | your programs, too.
 21 | 
 22 |   When we speak of free software, we are referring to freedom, not
 23 | price.  Our General Public Licenses are designed to make sure that you
 24 | have the freedom to distribute copies of free software (and charge for
 25 | them if you wish), that you receive source code or can get it if you
 26 | want it, that you can change the software or use pieces of it in new
 27 | free programs, and that you know you can do these things.
 28 | 
 29 |   To protect your rights, we need to prevent others from denying you
 30 | these rights or asking you to surrender the rights.  Therefore, you have
 31 | certain responsibilities if you distribute copies of the software, or if
 32 | you modify it: responsibilities to respect the freedom of others.
 33 | 
 34 |   For example, if you distribute copies of such a program, whether
 35 | gratis or for a fee, you must pass on to the recipients the same
 36 | freedoms that you received.  You must make sure that they, too, receive
 37 | or can get the source code.  And you must show them these terms so they
 38 | know their rights.
 39 | 
 40 |   Developers that use the GNU GPL protect your rights with two steps:
 41 | (1) assert copyright on the software, and (2) offer you this License
 42 | giving you legal permission to copy, distribute and/or modify it.
 43 | 
 44 |   For the developers' and authors' protection, the GPL clearly explains
 45 | that there is no warranty for this free software.  For both users' and
 46 | authors' sake, the GPL requires that modified versions be marked as
 47 | changed, so that their problems will not be attributed erroneously to
 48 | authors of previous versions.
 49 | 
 50 |   Some devices are designed to deny users access to install or run
 51 | modified versions of the software inside them, although the manufacturer
 52 | can do so.  This is fundamentally incompatible with the aim of
 53 | protecting users' freedom to change the software.  The systematic
 54 | pattern of such abuse occurs in the area of products for individuals to
 55 | use, which is precisely where it is most unacceptable.  Therefore, we
 56 | have designed this version of the GPL to prohibit the practice for those
 57 | products.  If such problems arise substantially in other domains, we
 58 | stand ready to extend this provision to those domains in future versions
 59 | of the GPL, as needed to protect the freedom of users.
 60 | 
 61 |   Finally, every program is threatened constantly by software patents.
 62 | States should not allow patents to restrict development and use of
 63 | software on general-purpose computers, but in those that do, we wish to
 64 | avoid the special danger that patents applied to a free program could
 65 | make it effectively proprietary.  To prevent this, the GPL assures that
 66 | patents cannot be used to render the program non-free.
 67 | 
 68 |   The precise terms and conditions for copying, distribution and
 69 | modification follow.
 70 | 
 71 |                        TERMS AND CONDITIONS
 72 | 
 73 |   0. Definitions.
 74 | 
 75 |   "This License" refers to version 3 of the GNU General Public License.
 76 | 
 77 |   "Copyright" also means copyright-like laws that apply to other kinds of
 78 | works, such as semiconductor masks.
 79 | 
 80 |   "The Program" refers to any copyrightable work licensed under this
 81 | License.  Each licensee is addressed as "you".  "Licensees" and
 82 | "recipients" may be individuals or organizations.
 83 | 
 84 |   To "modify" a work means to copy from or adapt all or part of the work
 85 | in a fashion requiring copyright permission, other than the making of an
 86 | exact copy.  The resulting work is called a "modified version" of the
 87 | earlier work or a work "based on" the earlier work.
 88 | 
 89 |   A "covered work" means either the unmodified Program or a work based
 90 | on the Program.
 91 | 
 92 |   To "propagate" a work means to do anything with it that, without
 93 | permission, would make you directly or secondarily liable for
 94 | infringement under applicable copyright law, except executing it on a
 95 | computer or modifying a private copy.  Propagation includes copying,
 96 | distribution (with or without modification), making available to the
 97 | public, and in some countries other activities as well.
 98 | 
 99 |   To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies.  Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 | 
103 |   An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License.  If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 | 
112 |   1. Source Code.
113 | 
114 |   The "source code" for a work means the preferred form of the work
115 | for making modifications to it.  "Object code" means any non-source
116 | form of a work.
117 | 
118 |   A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 | 
123 |   The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form.  A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 | 
134 |   The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities.  However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work.  For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 | 
147 |   The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 | 
151 |   The Corresponding Source for a work in source code form is that
152 | same work.
153 | 
154 |   2. Basic Permissions.
155 | 
156 |   All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met.  This License explicitly affirms your unlimited
159 | permission to run the unmodified Program.  The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work.  This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 | 
164 |   You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force.  You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright.  Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 | 
175 |   Conveying under any other circumstances is permitted solely under
176 | the conditions stated below.  Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 | 
179 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 | 
181 |   No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 | 
187 |   When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 | 
195 |   4. Conveying Verbatim Copies.
196 | 
197 |   You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 | 
205 |   You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 | 
208 |   5. Conveying Modified Source Versions.
209 | 
210 |   You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 | 
214 |     a) The work must carry prominent notices stating that you modified
215 |     it, and giving a relevant date.
216 | 
217 |     b) The work must carry prominent notices stating that it is
218 |     released under this License and any conditions added under section
219 |     7.  This requirement modifies the requirement in section 4 to
220 |     "keep intact all notices".
221 | 
222 |     c) You must license the entire work, as a whole, under this
223 |     License to anyone who comes into possession of a copy.  This
224 |     License will therefore apply, along with any applicable section 7
225 |     additional terms, to the whole of the work, and all its parts,
226 |     regardless of how they are packaged.  This License gives no
227 |     permission to license the work in any other way, but it does not
228 |     invalidate such permission if you have separately received it.
229 | 
230 |     d) If the work has interactive user interfaces, each must display
231 |     Appropriate Legal Notices; however, if the Program has interactive
232 |     interfaces that do not display Appropriate Legal Notices, your
233 |     work need not make them do so.
234 | 
235 |   A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit.  Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 | 
245 |   6. Conveying Non-Source Forms.
246 | 
247 |   You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 | 
252 |     a) Convey the object code in, or embodied in, a physical product
253 |     (including a physical distribution medium), accompanied by the
254 |     Corresponding Source fixed on a durable physical medium
255 |     customarily used for software interchange.
256 | 
257 |     b) Convey the object code in, or embodied in, a physical product
258 |     (including a physical distribution medium), accompanied by a
259 |     written offer, valid for at least three years and valid for as
260 |     long as you offer spare parts or customer support for that product
261 |     model, to give anyone who possesses the object code either (1) a
262 |     copy of the Corresponding Source for all the software in the
263 |     product that is covered by this License, on a durable physical
264 |     medium customarily used for software interchange, for a price no
265 |     more than your reasonable cost of physically performing this
266 |     conveying of source, or (2) access to copy the
267 |     Corresponding Source from a network server at no charge.
268 | 
269 |     c) Convey individual copies of the object code with a copy of the
270 |     written offer to provide the Corresponding Source.  This
271 |     alternative is allowed only occasionally and noncommercially, and
272 |     only if you received the object code with such an offer, in accord
273 |     with subsection 6b.
274 | 
275 |     d) Convey the object code by offering access from a designated
276 |     place (gratis or for a charge), and offer equivalent access to the
277 |     Corresponding Source in the same way through the same place at no
278 |     further charge.  You need not require recipients to copy the
279 |     Corresponding Source along with the object code.  If the place to
280 |     copy the object code is a network server, the Corresponding Source
281 |     may be on a different server (operated by you or a third party)
282 |     that supports equivalent copying facilities, provided you maintain
283 |     clear directions next to the object code saying where to find the
284 |     Corresponding Source.  Regardless of what server hosts the
285 |     Corresponding Source, you remain obligated to ensure that it is
286 |     available for as long as needed to satisfy these requirements.
287 | 
288 |     e) Convey the object code using peer-to-peer transmission, provided
289 |     you inform other peers where the object code and Corresponding
290 |     Source of the work are being offered to the general public at no
291 |     charge under subsection 6d.
292 | 
293 |   A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 | 
297 |   A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling.  In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage.  For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product.  A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 | 
310 |   "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source.  The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 | 
318 |   If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information.  But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 | 
329 |   The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed.  Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 | 
337 |   Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 | 
343 |   7. Additional Terms.
344 | 
345 |   "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law.  If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 | 
354 |   When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it.  (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.)  You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 | 
361 |   Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 | 
365 |     a) Disclaiming warranty or limiting liability differently from the
366 |     terms of sections 15 and 16 of this License; or
367 | 
368 |     b) Requiring preservation of specified reasonable legal notices or
369 |     author attributions in that material or in the Appropriate Legal
370 |     Notices displayed by works containing it; or
371 | 
372 |     c) Prohibiting misrepresentation of the origin of that material, or
373 |     requiring that modified versions of such material be marked in
374 |     reasonable ways as different from the original version; or
375 | 
376 |     d) Limiting the use for publicity purposes of names of licensors or
377 |     authors of the material; or
378 | 
379 |     e) Declining to grant rights under trademark law for use of some
380 |     trade names, trademarks, or service marks; or
381 | 
382 |     f) Requiring indemnification of licensors and authors of that
383 |     material by anyone who conveys the material (or modified versions of
384 |     it) with contractual assumptions of liability to the recipient, for
385 |     any liability that these contractual assumptions directly impose on
386 |     those licensors and authors.
387 | 
388 |   All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10.  If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term.  If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 | 
398 |   If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 | 
403 |   Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 | 
407 |   8. Termination.
408 | 
409 |   You may not propagate or modify a covered work except as expressly
410 | provided under this License.  Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 | 
415 |   However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 | 
422 |   Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 | 
429 |   Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License.  If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 | 
435 |   9. Acceptance Not Required for Having Copies.
436 | 
437 |   You are not required to accept this License in order to receive or
438 | run a copy of the Program.  Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance.  However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work.  These actions infringe copyright if you do
443 | not accept this License.  Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 | 
446 |   10. Automatic Licensing of Downstream Recipients.
447 | 
448 |   Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License.  You are not responsible
451 | for enforcing compliance by third parties with this License.
452 | 
453 |   An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations.  If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 | 
463 |   You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License.  For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 | 
471 |   11. Patents.
472 | 
473 |   A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based.  The
475 | work thus licensed is called the contributor's "contributor version".
476 | 
477 |   A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version.  For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 | 
487 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 | 
492 |   In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement).  To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 | 
499 |   If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients.  "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 | 
513 |   If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 | 
521 |   A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License.  You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 | 
536 |   Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 | 
540 |   12. No Surrender of Others' Freedom.
541 | 
542 |   If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License.  If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all.  For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 | 
552 |   13. Use with the GNU Affero General Public License.
553 | 
554 |   Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work.  The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 | 
563 |   14. Revised Versions of this License.
564 | 
565 |   The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time.  Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 | 
570 |   Each version is given a distinguishing version number.  If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation.  If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 | 
579 |   If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 | 
584 |   Later license versions may give you additional or different
585 | permissions.  However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 | 
589 |   15. Disclaimer of Warranty.
590 | 
591 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 | 
600 |   16. Limitation of Liability.
601 | 
602 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 | 
612 |   17. Interpretation of Sections 15 and 16.
613 | 
614 |   If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 | 
621 |                      END OF TERMS AND CONDITIONS
622 | 
623 |             How to Apply These Terms to Your New Programs
624 | 
625 |   If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 | 
629 |   To do so, attach the following notices to the program.  It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 | 
634 |     <one line to give the program's name and a brief idea of what it does.>
635 |     Copyright (C) <year>  <name of author>
636 | 
637 |     This program is free software: you can redistribute it and/or modify
638 |     it under the terms of the GNU General Public License as published by
639 |     the Free Software Foundation, either version 3 of the License, or
640 |     (at your option) any later version.
641 | 
642 |     This program is distributed in the hope that it will be useful,
643 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
644 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
645 |     GNU General Public License for more details.
646 | 
647 |     You should have received a copy of the GNU General Public License
648 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
649 | 
650 | Also add information on how to contact you by electronic and paper mail.
651 | 
652 |   If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 | 
655 |     <program>  Copyright (C) <year>  <name of author>
656 |     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 |     This is free software, and you are welcome to redistribute it
658 |     under certain conditions; type `show c' for details.
659 | 
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License.  Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 | 
664 |   You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | <https://www.gnu.org/licenses/>.
668 | 
669 |   The GNU General Public License does not permit incorporating your program
670 | into proprietary programs.  If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library.  If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License.  But first, please read
674 | <https://www.gnu.org/licenses/why-not-lgpl.html>.
675 | 


--------------------------------------------------------------------------------