Initial public commit.
This commit is contained in:
commit
670dac5c1b
244
.gitignore
vendored
Normal file
244
.gitignore
vendored
Normal file
|
@ -0,0 +1,244 @@
|
|||
|
||||
# Created by https://www.gitignore.io/api/python,pycharm,pycharm+all,pycharm+iml
|
||||
|
||||
### PyCharm ###
|
||||
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
|
||||
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
||||
|
||||
# User-specific stuff:
|
||||
.idea/**/workspace.xml
|
||||
.idea/**/tasks.xml
|
||||
.idea/dictionaries
|
||||
|
||||
# Sensitive or high-churn files:
|
||||
.idea/**/dataSources/
|
||||
.idea/**/dataSources.ids
|
||||
.idea/**/dataSources.xml
|
||||
.idea/**/dataSources.local.xml
|
||||
.idea/**/sqlDataSources.xml
|
||||
.idea/**/dynamic.xml
|
||||
.idea/**/uiDesigner.xml
|
||||
|
||||
# Gradle:
|
||||
.idea/**/gradle.xml
|
||||
.idea/**/libraries
|
||||
|
||||
# CMake
|
||||
cmake-build-debug/
|
||||
|
||||
# Mongo Explorer plugin:
|
||||
.idea/**/mongoSettings.xml
|
||||
|
||||
## File-based project format:
|
||||
*.iws
|
||||
|
||||
## Plugin-specific files:
|
||||
|
||||
# IntelliJ
|
||||
/out/
|
||||
|
||||
# mpeltonen/sbt-idea plugin
|
||||
.idea_modules/
|
||||
|
||||
# JIRA plugin
|
||||
atlassian-ide-plugin.xml
|
||||
|
||||
# Cursive Clojure plugin
|
||||
.idea/replstate.xml
|
||||
|
||||
# Ruby plugin and RubyMine
|
||||
/.rakeTasks
|
||||
|
||||
# Crashlytics plugin (for Android Studio and IntelliJ)
|
||||
com_crashlytics_export_strings.xml
|
||||
crashlytics.properties
|
||||
crashlytics-build.properties
|
||||
fabric.properties
|
||||
|
||||
### PyCharm Patch ###
|
||||
# Comment Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-215987721
|
||||
|
||||
# *.iml
|
||||
# modules.xml
|
||||
# .idea/misc.xml
|
||||
# *.ipr
|
||||
|
||||
# Sonarlint plugin
|
||||
.idea/sonarlint
|
||||
|
||||
### PyCharm+all ###
|
||||
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
|
||||
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
||||
|
||||
# User-specific stuff:
|
||||
|
||||
# Sensitive or high-churn files:
|
||||
|
||||
# Gradle:
|
||||
|
||||
# CMake
|
||||
|
||||
# Mongo Explorer plugin:
|
||||
|
||||
## File-based project format:
|
||||
|
||||
## Plugin-specific files:
|
||||
|
||||
# IntelliJ
|
||||
|
||||
# mpeltonen/sbt-idea plugin
|
||||
|
||||
# JIRA plugin
|
||||
|
||||
# Cursive Clojure plugin
|
||||
|
||||
# Ruby plugin and RubyMine
|
||||
|
||||
# Crashlytics plugin (for Android Studio and IntelliJ)
|
||||
|
||||
### PyCharm+all Patch ###
|
||||
# Ignores the whole idea folder
|
||||
# See https://github.com/joeblau/gitignore.io/issues/186 and https://github.com/joeblau/gitignore.io/issues/360
|
||||
|
||||
.idea/
|
||||
|
||||
### PyCharm+iml ###
|
||||
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
|
||||
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
||||
|
||||
# User-specific stuff:
|
||||
|
||||
# Sensitive or high-churn files:
|
||||
|
||||
# Gradle:
|
||||
|
||||
# CMake
|
||||
|
||||
# Mongo Explorer plugin:
|
||||
|
||||
## File-based project format:
|
||||
|
||||
## Plugin-specific files:
|
||||
|
||||
# IntelliJ
|
||||
|
||||
# mpeltonen/sbt-idea plugin
|
||||
|
||||
# JIRA plugin
|
||||
|
||||
# Cursive Clojure plugin
|
||||
|
||||
# Ruby plugin and RubyMine
|
||||
|
||||
# Crashlytics plugin (for Android Studio and IntelliJ)
|
||||
|
||||
### PyCharm+iml Patch ###
|
||||
# Reason: https://github.com/joeblau/gitignore.io/issues/186#issuecomment-249601023
|
||||
|
||||
*.iml
|
||||
modules.xml
|
||||
.idea/misc.xml
|
||||
*.ipr
|
||||
|
||||
### Python ###
|
||||
# Byte-compiled / optimized / DLL files
|
||||
__pycache__/
|
||||
*.py[cod]
|
||||
*$py.class
|
||||
|
||||
# C extensions
|
||||
*.so
|
||||
|
||||
# Distribution / packaging
|
||||
.Python
|
||||
build/
|
||||
develop-eggs/
|
||||
dist/
|
||||
downloads/
|
||||
eggs/
|
||||
.eggs/
|
||||
lib/
|
||||
lib64/
|
||||
parts/
|
||||
sdist/
|
||||
var/
|
||||
wheels/
|
||||
*.egg-info/
|
||||
.installed.cfg
|
||||
*.egg
|
||||
|
||||
# PyInstaller
|
||||
# Usually these files are written by a python script from a template
|
||||
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
||||
*.manifest
|
||||
*.spec
|
||||
|
||||
# Installer logs
|
||||
pip-log.txt
|
||||
pip-delete-this-directory.txt
|
||||
|
||||
# Unit test / coverage reports
|
||||
htmlcov/
|
||||
.tox/
|
||||
.coverage
|
||||
.coverage.*
|
||||
.cache
|
||||
.pytest_cache/
|
||||
nosetests.xml
|
||||
coverage.xml
|
||||
*.cover
|
||||
.hypothesis/
|
||||
|
||||
# Translations
|
||||
*.mo
|
||||
*.pot
|
||||
|
||||
# Flask stuff:
|
||||
instance/
|
||||
.webassets-cache
|
||||
|
||||
# Scrapy stuff:
|
||||
.scrapy
|
||||
|
||||
# Sphinx documentation
|
||||
docs/_build/
|
||||
|
||||
# PyBuilder
|
||||
target/
|
||||
|
||||
# Jupyter Notebook
|
||||
.ipynb_checkpoints
|
||||
|
||||
# pyenv
|
||||
.python-version
|
||||
|
||||
# celery beat schedule file
|
||||
celerybeat-schedule.*
|
||||
|
||||
# SageMath parsed files
|
||||
*.sage.py
|
||||
|
||||
# Environments
|
||||
.env
|
||||
.venv
|
||||
env/
|
||||
venv/
|
||||
ENV/
|
||||
env.bak/
|
||||
venv.bak/
|
||||
|
||||
# Spyder project settings
|
||||
.spyderproject
|
||||
.spyproject
|
||||
|
||||
# Rope project settings
|
||||
.ropeproject
|
||||
|
||||
# mkdocs documentation
|
||||
/site
|
||||
|
||||
# mypy
|
||||
.mypy_cache/
|
||||
|
||||
|
||||
# End of https://www.gitignore.io/api/python,pycharm,pycharm+all,pycharm+iml
|
674
LICENSE.txt
Normal file
674
LICENSE.txt
Normal file
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
20
README.md
Normal file
20
README.md
Normal file
|
@ -0,0 +1,20 @@
|
|||
# Daily Releases: *A reddit bot that consolidates scene releases*
|
||||
|
||||
## Quick Start
|
||||
### Installation
|
||||
The easiest way to install the bot is to use pip:
|
||||
|
||||
```bash
|
||||
pip3 install --upgrade https://git.caspervk.net/caspervk/dailyreleases/archive/master.tar.gz
|
||||
```
|
||||
|
||||
**It requires Python 3.6 or later.**
|
||||
|
||||
### Usage
|
||||
The program can be started by running `dailyreleases` or `python3 -m dailyreleases` depending on system configuration.
|
||||
|
||||
### Configuration
|
||||
The default configuration file will be copied to `~/.dailyreleases/config.ini` on the first run. All fields under the
|
||||
[reddit] and [google] sections need to be filled out before the bot can be initialized.
|
||||
|
||||
To append content to the generated post, add a file `~/.dailyreleases/epilogue.txt`.
|
3
dailyreleases/__init__.py
Normal file
3
dailyreleases/__init__.py
Normal file
|
@ -0,0 +1,3 @@
|
|||
__version__ = "0.0.2"
|
||||
__author__ = "Casper V. Kristensen"
|
||||
__licence__ = "GPLv3"
|
7
dailyreleases/__main__.py
Normal file
7
dailyreleases/__main__.py
Normal file
|
@ -0,0 +1,7 @@
|
|||
"""
|
||||
The main terminal-based entry point. Invoke as `dailyreleases' or `python3 -m dailyreleases'.
|
||||
"""
|
||||
|
||||
if __name__ == '__main__':
|
||||
from .main import main
|
||||
main()
|
46
dailyreleases/config.ini.default
Normal file
46
dailyreleases/config.ini.default
Normal file
|
@ -0,0 +1,46 @@
|
|||
[main]
|
||||
# true : Listen for reddit PMs; on receipt, generate and submit post to own subreddit. Reply with link to post.
|
||||
# false : Immediately generate and print post to log and console. Nothing is posted to reddit.
|
||||
production = false
|
||||
|
||||
|
||||
[logging]
|
||||
level = DEBUG
|
||||
file = logs/main.log
|
||||
backup_count = 10
|
||||
|
||||
|
||||
[reddit]
|
||||
# Create personal use script on https://reddit.com/prefs/apps/ from the bot's reddit account, and register it for
|
||||
# production API use.
|
||||
client_id = xxxxxxxxxxxxxx
|
||||
client_secret = xxxxxxxxxxx-xxxxxxxxxxxxxxx
|
||||
user_agent = <platform>:<app ID>:<version string> (by /u/<reddit username>)
|
||||
username = xxxxxxxxxxxxx
|
||||
password = xxxxxxx
|
||||
|
||||
# List of users who are allowed to PM the bot.
|
||||
authorized_users = spez,Deimorz,kn0thing
|
||||
|
||||
# Reddit perceives PMs with many links as spam, so the bot posts the code for the generated post in its own subreddit.
|
||||
bot_subreddit = dailyreleases
|
||||
|
||||
# It also needs to know of the subreddit where the daily releases threads are posted so it can link to the previous one.
|
||||
posts_subreddit = crackwatch
|
||||
|
||||
|
||||
[google]
|
||||
# Create a custom search engine on https://cse.google.com/cse/create/new:
|
||||
# - Sites to search can be anything, e.g. "example.com".
|
||||
# - After creation, delete the url under "Sites to search" and set "Search the entire web" to OFF. (Yes, OFF!).
|
||||
# - "Image search" OFF.
|
||||
# - Find search engine ID (cx) on the setup-page for the custom search engine.
|
||||
# - Get the key on https://developers.google.com/custom-search/json-api/v1/introduction.
|
||||
cx = xxxxxxxxxxxxxxxxxxxxx:xxxxxxxxxxx
|
||||
key = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
|
||||
|
||||
[web]
|
||||
# Number of seconds to cache web requests (google, steam etc.). May help reduce the number of requests if the same game
|
||||
# has multiple scene releases on the same day.
|
||||
cache_time = 600
|
84
dailyreleases/config.py
Normal file
84
dailyreleases/config.py
Normal file
|
@ -0,0 +1,84 @@
|
|||
import configparser
|
||||
import logging
|
||||
import logging.config
|
||||
import os
|
||||
import shutil
|
||||
from pathlib import Path
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
PACKAGE_ROOT = Path(__file__).resolve().parent
|
||||
DEFAULT_CONFIG_FILE = PACKAGE_ROOT.joinpath("config.ini.default")
|
||||
DATA_DIR = Path.home().joinpath(".dailyreleases")
|
||||
CONFIG_FILE = DATA_DIR.joinpath("config.ini")
|
||||
|
||||
|
||||
def read_config() -> configparser.ConfigParser:
|
||||
"""
|
||||
Read and return config file. Copies default config template to data dir if it doesn't already exists.
|
||||
"""
|
||||
if not CONFIG_FILE.exists():
|
||||
print("Copying default configuration file..")
|
||||
os.makedirs(DATA_DIR, exist_ok=True)
|
||||
shutil.copyfile(DEFAULT_CONFIG_FILE, CONFIG_FILE)
|
||||
|
||||
print("Please customize", CONFIG_FILE)
|
||||
exit()
|
||||
|
||||
config = configparser.ConfigParser()
|
||||
config.read(CONFIG_FILE)
|
||||
|
||||
return config
|
||||
|
||||
|
||||
def initialize_logging(config: configparser.ConfigParser):
|
||||
"""
|
||||
Set up logging.
|
||||
"""
|
||||
log_file = DATA_DIR.joinpath(config["logging"]["file"])
|
||||
log_level = config["logging"]["level"]
|
||||
log_backup_count = config["logging"].getint("backup_count")
|
||||
|
||||
os.makedirs(log_file.parent, exist_ok=True)
|
||||
logging.config.dictConfig(logging_config(log_file, log_level, log_backup_count))
|
||||
|
||||
logger.info("Logging level is %s", log_level)
|
||||
logger.info("Logging to %s - backup count is %s", log_file, log_backup_count)
|
||||
|
||||
|
||||
def logging_config(file, level, backup_count):
|
||||
return {
|
||||
"version": 1,
|
||||
"disable_existing_loggers": False,
|
||||
"formatters": {
|
||||
"standard": {
|
||||
"format": "%(asctime)s [%(levelname)-7s] %(name)s:%(funcName)s - %(message)s"
|
||||
}
|
||||
},
|
||||
"handlers": {
|
||||
"console": {
|
||||
"class": "logging.StreamHandler",
|
||||
"stream": "ext://sys.stdout",
|
||||
"formatter": "standard",
|
||||
"level": level
|
||||
},
|
||||
"file": {
|
||||
"class": "logging.handlers.TimedRotatingFileHandler",
|
||||
"when": "midnight",
|
||||
"backupCount": backup_count,
|
||||
"filename": DATA_DIR.joinpath(file),
|
||||
"encoding": "utf-8",
|
||||
"formatter": "standard",
|
||||
"level": level
|
||||
}
|
||||
},
|
||||
"loggers": {
|
||||
"dailyreleases": {
|
||||
"level": level
|
||||
}
|
||||
},
|
||||
"root": {
|
||||
"handlers": ["console", "file"],
|
||||
"level": "WARNING"
|
||||
}
|
||||
}
|
414
dailyreleases/main.py
Normal file
414
dailyreleases/main.py
Normal file
|
@ -0,0 +1,414 @@
|
|||
import inspect
|
||||
import json
|
||||
import logging
|
||||
import re
|
||||
import string
|
||||
import textwrap
|
||||
import time
|
||||
from collections import defaultdict
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
import prawcore
|
||||
import requests_cache
|
||||
from tabulate import tabulate
|
||||
|
||||
from dailyreleases import config, __version__
|
||||
from dailyreleases.predb import Predb
|
||||
from dailyreleases.reddit import Reddit
|
||||
from dailyreleases.steam import Steam
|
||||
from dailyreleases.web import Web
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class DailyReleasesBot(object):
|
||||
def __init__(self) -> None:
|
||||
print(f"Starting Daily Releases Bot v{__version__}")
|
||||
|
||||
# Load config file and initialize logging based on its contents
|
||||
self.config = config.read_config()
|
||||
config.initialize_logging(self.config)
|
||||
|
||||
# Setup caching of requests; helps reduce the number of requests if the same game gets multiple releases
|
||||
cache_time = self.config["web"].getint("cache_time")
|
||||
self.cache = requests_cache.core.CachedSession(cache_name=str(config.DATA_DIR.joinpath("cache")),
|
||||
expire_after=cache_time)
|
||||
logger.info("Requests cache time is %ss", cache_time)
|
||||
|
||||
# Initialize sub-modules
|
||||
self.web = Web(self.config, self.cache)
|
||||
self.predb = Predb(self.config, self.cache)
|
||||
self.steam = Steam(self.config, self.cache)
|
||||
self.reddit = Reddit(self.config)
|
||||
|
||||
def run(self):
|
||||
# If not production, generate now (without posting to reddit) and then exit
|
||||
if not self.config["main"].getboolean("production"):
|
||||
self.generate()
|
||||
return
|
||||
|
||||
# Retry forever because PRAW (or reddit) sucks
|
||||
while True:
|
||||
try:
|
||||
logger.info("Listening on reddit inbox stream")
|
||||
for message in self.reddit.praw.inbox.stream():
|
||||
if message.author not in self.config["reddit"]["authorized_users"].split(","):
|
||||
logger.info("Discarding PM from %s: not in authorized users", message.author)
|
||||
continue
|
||||
|
||||
self.generate(pm_recipient=message.author.name)
|
||||
|
||||
# clean requests cache after each successful generation so it doesn't grow indefinitely
|
||||
self.cache.remove_expired_responses()
|
||||
|
||||
except prawcore.PrawcoreException as e:
|
||||
logger.warning("PrawcoreException: %s", e)
|
||||
logger.info("Restarting inbox listener..")
|
||||
|
||||
except KeyboardInterrupt:
|
||||
print("Exiting (KeyboardInterrupt)")
|
||||
break
|
||||
|
||||
def find_store_link(self, game_name):
|
||||
"""
|
||||
Try to find hyperlink to a store selling this game.
|
||||
|
||||
:return: (Link, name of store)
|
||||
"""
|
||||
# Try searching the Steam store for the game
|
||||
link = self.steam.search(game_name)
|
||||
if link:
|
||||
return link, "Steam"
|
||||
|
||||
# If that didn't work, try Googling the game
|
||||
known_stores = {
|
||||
"store.steampowered.com/(app|sub)": "Steam", # order doesn't matter
|
||||
"store.steampowered.com/bundle": "Steam Bundle",
|
||||
"gog.com/game": "GOG",
|
||||
"origin.com": "Origin",
|
||||
"ubi(soft)?.com": "Ubisoft",
|
||||
"www.microsoft.com/.*p": "Microsoft Store",
|
||||
"itch.io": "Itch.io",
|
||||
"bigfishgames.com": "Big Fish Games",
|
||||
"gamejolt.com": "Game Jolt",
|
||||
"alawar.com": "Alawar",
|
||||
"wildtangent.com": "WildTangent Games"
|
||||
}
|
||||
|
||||
for link in self.web.search(f"{game_name} buy"):
|
||||
for store_url, store_name in known_stores.items():
|
||||
if re.search(store_url, link, flags=re.IGNORECASE):
|
||||
return link, store_name
|
||||
|
||||
logger.debug("Unable to find store link for %s", game_name)
|
||||
return None, None
|
||||
|
||||
def parse_dirname(self, dirname):
|
||||
logger.info("---")
|
||||
logger.info("Parsing: %s", dirname)
|
||||
|
||||
# Extract group name
|
||||
rls_name, group = dirname.rsplit("-", 1)
|
||||
|
||||
# Find game name by matching until one of the stopwords
|
||||
game_name, *stopwords = re.split("[._-](update|v[0-9]+|Crack[._-]?fix|mac[._-]?os[._-]?x?|linux|MULTI[0-9]+|RIP"
|
||||
"|GOG|PROPER|REPACK|Multilanguage|incl|Standalone|x(?:86|64)"
|
||||
"|(?:86|64)[._-]?bit|German|CZECH|RUSSIAN|KOREAN|ITALIAN|SWEDISH|DANISH|French"
|
||||
"|Slovak|DIR[._-]?FIX|build[._-]?[0-9]+|READNFO|Hotfix|DLC[._-]?Unlocker"
|
||||
"|iNTERNAL|Steam[._-]?Edition)",
|
||||
rls_name, flags=re.IGNORECASE)
|
||||
|
||||
# Prettify game name by substituting word delimiters with spaces and capitalizing each word
|
||||
game_name = string.capwords(re.sub("[._-]", " ", game_name))
|
||||
|
||||
# Some stopwords are interesting enough to add next to the game in parentheses - we call these tags
|
||||
tags = [stopword
|
||||
for stopword in stopwords
|
||||
if re.match("Crack[._-]?fix|MULTI[0-9]+|RIP|REPACK|x(?:86|64)|(?:86|64)[._-]?bit|German|CZECH|RUSSIAN"
|
||||
"|KOREAN|ITALIAN|SWEDISH|DANISH|French|Slovak|Hotfix|DIR[._-]?FIX",
|
||||
stopword, flags=re.IGNORECASE)]
|
||||
|
||||
# Some stopwords are even more interesting and deserve to be highlighted (e.g. '- PROPER' next to the name)
|
||||
highlights = [highlight
|
||||
for highlight in stopwords
|
||||
if re.match("PROPER|READNFO", highlight, flags=re.IGNORECASE)]
|
||||
|
||||
# Find platform
|
||||
if re.search("mac[._-]?os[._-]?x?", rls_name, flags=re.IGNORECASE):
|
||||
platform = "Mac OSX"
|
||||
elif re.search("linux", rls_name, flags=re.IGNORECASE):
|
||||
platform = "Linux"
|
||||
else:
|
||||
platform = "Windows"
|
||||
|
||||
# Find type (games/dlc/updates)
|
||||
rls_type = "Games"
|
||||
|
||||
# Order of the if-statements is important: update trumps dlc because an update to a DLC is an update, not a dlc!
|
||||
if re.search("(?<!incl[._-])dlc", # 'Incl.DLC' isn't a DLC-release
|
||||
rls_name, flags=re.IGNORECASE):
|
||||
rls_type = "DLC"
|
||||
if re.search("update|v[0-9]|addon|Crack[._-]?fix|DIR[._-]?FIX|build[._-]?[0-9]+",
|
||||
rls_name, flags=re.IGNORECASE):
|
||||
rls_type = "Updates"
|
||||
|
||||
logger.info("Offline: %s %s : %s - %s", platform, rls_type, game_name, group)
|
||||
logger.info("Tags: %s. Highlights: %s", tags, highlights)
|
||||
|
||||
# Find store link
|
||||
store_link, store_name = self.find_store_link(game_name)
|
||||
|
||||
# No store link? Probably software and not a game
|
||||
if not store_link:
|
||||
logger.info("Skipping %s: no store link (probably software)", dirname)
|
||||
return
|
||||
|
||||
# Sadly, Steam is the de facto pc game store. Therefore, (almost) all the popular games are published there.
|
||||
# For this reason, game popularity and score is -1 be default; it is updated if the game exists on Steam.
|
||||
popularity = -1
|
||||
review_score = -1
|
||||
|
||||
# If the store link we found is to Steam, use their API to get (better) information about the game.
|
||||
# Note: Doesn't apply to Steam bundles, as Steam has no public API for those.
|
||||
if store_name == "Steam":
|
||||
logger.debug("Getting information about game using Steam API")
|
||||
steam_type, steam_appid = re.search("(app|sub)(?:/)([0-9]+)", store_link).groups()
|
||||
|
||||
# If the release is a package on Steam (e.g. game + dlc), we need to find the base game of the package
|
||||
if steam_type == "sub":
|
||||
steam_packagedetails = self.steam.packagedetails(steam_appid)
|
||||
|
||||
# Set game name to package name (e.g. 'Fallout New Vegas Ultimate' instead of 'Fallout New Vegas')
|
||||
game_name = steam_packagedetails["name"]
|
||||
|
||||
# Find the "base game" of the package (the most popular app in the package)
|
||||
steam_package_appids = {str(app["id"]) for app in steam_packagedetails["apps"]}
|
||||
steam_package_appdetails = [self.steam.appdetails(appid) for appid in steam_package_appids]
|
||||
steam_package_basegame_appdetails = max(steam_package_appdetails,
|
||||
key=lambda app: self.steam.popularity(app["steam_appid"]))
|
||||
|
||||
# Use the base game of the package as the basis for further computation
|
||||
steam_appdetails = steam_package_basegame_appdetails
|
||||
steam_appid = steam_package_basegame_appdetails["steam_appid"]
|
||||
|
||||
# Otherwise, if the release is a single game on Steam
|
||||
else:
|
||||
steam_appdetails = self.steam.appdetails(steam_appid)
|
||||
game_name = steam_appdetails["name"]
|
||||
|
||||
# Now that we have chosen a single Steam game to represent the release, use it to improve the information
|
||||
popularity = self.steam.popularity(steam_appid)
|
||||
review_score = self.steam.review_score(steam_appid)
|
||||
|
||||
# DLC releases doesn't always contain the word "dlc" (e.g. 'Fallout New Vegas: Dead Money'), so some DLCs
|
||||
# get mislabeled as games during offline parsing. We can use the Steam API to get the correct release type,
|
||||
# but if the release was already deemed an update, keep it as such, because an update to a DLC is an update.
|
||||
if rls_type != "Updates" and steam_appdetails["type"] == "dlc":
|
||||
rls_type = "DLC"
|
||||
|
||||
# If Steam links to a 3rd-party EULAs, check it for the word "denuvo" and add a highlight if it occurs
|
||||
if "denuvo" in self.steam.eula(steam_appid).lower():
|
||||
logger.info("'denuvo' found in EULA; adding 'DENUVO' to highlights")
|
||||
highlights.append("DENUVO")
|
||||
|
||||
# We only called it "Steam Bundle" to bypass the Steam-API logic. Fix for aesthetics.
|
||||
if store_name == "Steam Bundle":
|
||||
store_name = "Steam"
|
||||
|
||||
release = {
|
||||
"dirname": dirname,
|
||||
"rls_name": rls_name, # dirname without group
|
||||
"group": group,
|
||||
"game_name": game_name,
|
||||
"type": rls_type,
|
||||
"platform": platform,
|
||||
"store_link": store_link,
|
||||
"store_name": store_name,
|
||||
"popularity": popularity,
|
||||
"review_score": review_score,
|
||||
"tags": tags,
|
||||
"highlights": highlights
|
||||
}
|
||||
|
||||
logger.info("Final : %s %s : %s - %s : %s", platform, rls_type, game_name, group, json.dumps(release))
|
||||
return release
|
||||
|
||||
def parse_releases(self, releases, already_posted):
|
||||
parsed_releases = defaultdict(lambda: defaultdict(list))
|
||||
failed = set()
|
||||
|
||||
# Remove old releases from already_posted to save space and memory
|
||||
already_posted.intersection_update(releases)
|
||||
|
||||
for dirname, (nfo_link, timestamp) in releases.items():
|
||||
# Skip release if already posted in a previous daily releases post
|
||||
if dirname in already_posted:
|
||||
logger.info("Skipping %s: dirname in already posted", dirname)
|
||||
continue
|
||||
|
||||
# Skip release if dirname contains any of the blacklisted words (we only want pc games!)
|
||||
if re.search("Keygen|Keymaker|Lynda|3ds[._-]?Max|For[._-]Maya|Fedora|openSUSE|Ubuntu|Debian|jQuery|CSS"
|
||||
"|Cinema4D|3DS|[._-]Wii|[._-]WiiU|ASP[._-]NET|[._-]PSP|[._-]NSW|Windows[._-]Server|OREILLY"
|
||||
"|TUTORIAL|1080p|720p|x264|eBook|PS4|Wintellectnow",
|
||||
dirname, flags=re.IGNORECASE):
|
||||
logger.info("Skipping %s: contains blacklisted word", dirname)
|
||||
continue
|
||||
|
||||
# Skip release if it is older than 48 hours
|
||||
if timestamp < datetime.now() - timedelta(hours=48):
|
||||
logger.info("Skipping %s: older than 48 hours (but not in already_posted!)", dirname)
|
||||
continue
|
||||
|
||||
# Parse dirname
|
||||
try:
|
||||
parsed_dirname = self.parse_dirname(dirname)
|
||||
except Exception as e:
|
||||
failed.add(dirname)
|
||||
logger.exception(e)
|
||||
continue
|
||||
|
||||
# Skip if there is no data about the release (e.g. if it is deemed a non-game)
|
||||
if not parsed_dirname:
|
||||
continue
|
||||
|
||||
# Add release to dict of parsed releases by platform and type
|
||||
release = {**parsed_dirname, "nfo_link": nfo_link}
|
||||
parsed_releases[release["platform"]][release["type"]].append(release)
|
||||
|
||||
already_posted.add(dirname)
|
||||
|
||||
logger.debug("Parsed releases: %s", json.dumps(parsed_releases))
|
||||
logger.debug("Failed releases: %s", ", ".join(failed))
|
||||
return parsed_releases, failed
|
||||
|
||||
def generate_post(self, parsed_releases):
|
||||
post = []
|
||||
for platform_name, platform_releases in sorted(parsed_releases.items(),
|
||||
key=lambda n: ("Windows", "Mac OSX", "Linux").index(n[0])):
|
||||
# Skip platform if there are no releases for it
|
||||
if not platform_releases:
|
||||
continue
|
||||
|
||||
post.append(f"# {platform_name}")
|
||||
|
||||
for type_name, type_releases in sorted(platform_releases.items(),
|
||||
key=lambda n: ("Games", "Updates", "DLC").index(n[0])):
|
||||
# Skip release type if there are no releases for it
|
||||
if not type_releases:
|
||||
continue
|
||||
|
||||
# The sub-tables for updates will use the entire rls_name as the name, while games and dlcs will show
|
||||
# tags and highlights, as well as the actual game_name
|
||||
if type_name == "Updates":
|
||||
name = lambda r: "[{name}]({nfo})".format(name=r["rls_name"], nfo=r["nfo_link"])
|
||||
else:
|
||||
tags = lambda r: " ({})".format(" ".join(r["tags"])) if r["tags"] else ""
|
||||
highlights = lambda r: " **- {}**".format(", ".join(r["highlights"])) if r["highlights"] else ""
|
||||
name = lambda r: "[{name}{tags}]({nfo}){highlights}".format(name=r["game_name"],
|
||||
tags=tags(r),
|
||||
nfo=r["nfo_link"],
|
||||
highlights=highlights(r))
|
||||
review = lambda r: "{:.0%}".format(r["review_score"]) if r["review_score"] != -1 else "-"
|
||||
store = lambda r: "[{}]({})".format(r["store_name"], r["store_link"])
|
||||
|
||||
# Releases in these sub-tables are grouped by release group, and the groups are ordered according to the
|
||||
# most popular game within the group. Games are sorted by popularity internally in the groups.
|
||||
max_group_popularity = defaultdict(int)
|
||||
for rls in type_releases:
|
||||
max_group_popularity[rls["group"]] = max(max_group_popularity[rls["group"]], rls["popularity"])
|
||||
|
||||
table = [(name(rls), rls["group"], review(rls), store(rls))
|
||||
for rls in sorted(type_releases,
|
||||
key=lambda r: (max_group_popularity[r["group"]], r["popularity"]),
|
||||
reverse=True)]
|
||||
post.append(tabulate(table, headers=(type_name, "Group", "Reviews", "Store"), tablefmt="pipe"))
|
||||
|
||||
post.append("")
|
||||
post.append(" ")
|
||||
post.append("")
|
||||
|
||||
post.append("")
|
||||
post.append("")
|
||||
|
||||
if not post:
|
||||
logger.warning("Post is empty!")
|
||||
post.append("No releases today! :o")
|
||||
|
||||
# Add link to the previous release thread
|
||||
previous_post = self.reddit.get_previous_daily_post(self.config["reddit"]["posts_subreddit"])
|
||||
previous_post_date = re.search("daily release.*[(](.*)[)]", previous_post.title, flags=re.IGNORECASE).group(1)
|
||||
post.append("# [<< {}]({})".format(previous_post_date, previous_post.url))
|
||||
|
||||
# Add epilogue
|
||||
try:
|
||||
with config.DATA_DIR.joinpath("epilogue.txt").open() as file:
|
||||
post.extend(line.rstrip() for line in file.readlines())
|
||||
except FileNotFoundError:
|
||||
logger.info("epilogue.txt not found")
|
||||
|
||||
# Convert post list to string
|
||||
post_str = "\n".join(post)
|
||||
|
||||
logger.debug("Generated post:\n%s", post_str)
|
||||
return post_str
|
||||
|
||||
def generate(self, pm_recipient=None):
|
||||
logger.info("-------------------------------------------------------------------------------------------------")
|
||||
start_time = time.time()
|
||||
|
||||
already_posted = self.load_already_posted()
|
||||
|
||||
releases = self.predb.get_releases()
|
||||
parsed_releases, failed_dirnames = self.parse_releases(releases, already_posted)
|
||||
|
||||
post = self.generate_post(parsed_releases)
|
||||
source = textwrap.indent(post, " ")
|
||||
|
||||
# The date of the post changes at midday instead of midnight to allow calling script after 00:00
|
||||
title = "Daily Releases ({})".format((datetime.today() - timedelta(hours=12)).strftime("%B %-d, %Y"))
|
||||
|
||||
if pm_recipient:
|
||||
# Post to bot's subreddit
|
||||
source_post = self.reddit.submit_post(f"{title} - Source", source, self.config["reddit"]["bot_subreddit"])
|
||||
preview_post = self.reddit.submit_post(title, post, self.config["reddit"]["bot_subreddit"])
|
||||
|
||||
# Manually approve posts since reddit seem to think posts with many links are spam
|
||||
source_post.mod.approve()
|
||||
preview_post.mod.approve()
|
||||
|
||||
# Write and send PM to whoever initiated the generation
|
||||
msg = inspect.cleandoc(
|
||||
f"""
|
||||
[Preview]({preview_post.url})
|
||||
[Source]({source_post.url})
|
||||
Failed: {", ".join(failed_dirnames)}
|
||||
"""
|
||||
)
|
||||
self.reddit.praw.redditor(pm_recipient).message(title, msg)
|
||||
|
||||
self.save_already_posted(already_posted)
|
||||
|
||||
logger.info("Execution took %s seconds", int(time.time() - start_time))
|
||||
logger.info("-------------------------------------------------------------------------------------------------")
|
||||
|
||||
def load_already_posted(self):
|
||||
try:
|
||||
with config.DATA_DIR.joinpath("already_posted").open() as file:
|
||||
return set(line.rstrip() for line in file.readlines())
|
||||
except FileNotFoundError:
|
||||
return set()
|
||||
|
||||
def save_already_posted(self, already_posted):
|
||||
logger.info("Saving already posted to file")
|
||||
with config.DATA_DIR.joinpath("already_posted").open("w") as file:
|
||||
for dirname in already_posted:
|
||||
file.write("{}\n".format(dirname))
|
||||
|
||||
|
||||
def main():
|
||||
bot = DailyReleasesBot()
|
||||
bot.run()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
55
dailyreleases/predb.py
Normal file
55
dailyreleases/predb.py
Normal file
|
@ -0,0 +1,55 @@
|
|||
import logging
|
||||
from datetime import datetime
|
||||
|
||||
from bs4 import BeautifulSoup
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Predb(object):
|
||||
def __init__(self, config, cache) -> None:
|
||||
self.config = config
|
||||
self.cache = cache
|
||||
|
||||
def get_releases(self):
|
||||
logger.info("Getting releases from predbs")
|
||||
|
||||
return {**self._get_predbme(), **self._get_srrdb(), **self._get_xrel()} # in reverse order of preference
|
||||
|
||||
def _get_xrel(self, categories=("CRACKED", "UPDATE"), num_pages=2):
|
||||
logger.debug("Getting releases from xrel.to")
|
||||
|
||||
def get_releases_in_category(category, page):
|
||||
payload = {
|
||||
"category_name": category,
|
||||
"ext_info_type": "game",
|
||||
"per_page": 100,
|
||||
"page": page
|
||||
}
|
||||
r = self.cache.get("https://api.xrel.to/v2/release/browse_category.json", params=payload)
|
||||
return r.json()["list"]
|
||||
|
||||
return {rls["dirname"]: (rls["link_href"], datetime.fromtimestamp(rls["time"]))
|
||||
for category in categories
|
||||
for page in range(1, num_pages)
|
||||
for rls in get_releases_in_category(category, page)}
|
||||
|
||||
def _get_srrdb(self, num_pages=3):
|
||||
logger.debug("Getting releases from srrdb.com")
|
||||
|
||||
return {rls["release"]: ("https://www.srrdb.com/release/details/{}".format(rls['release']),
|
||||
datetime.strptime(rls["date"], "%Y-%m-%d %H:%M:%S"))
|
||||
for p in range(1, num_pages)
|
||||
for rls in
|
||||
self.cache.get(f"https://www.srrdb.com/api/search/category:pc/order:date-desc/{p}").json()["results"]}
|
||||
|
||||
def _get_predbme(self):
|
||||
logger.debug("Getting releases from predb.me")
|
||||
|
||||
r = self.cache.get("https://predb.me/?cats=games-pc&rss=1")
|
||||
soup = BeautifulSoup(r.text, "html.parser").find_all("item")
|
||||
|
||||
# Predb.me doesn't show timestamps in the RSS-feed, but the feed is so short it only shows ~72 hours worth of
|
||||
# releases anyway, so we just set timestamp to now.
|
||||
return {item.find("title").text: (item.find("guid").text, datetime.utcnow())
|
||||
for item in soup}
|
24
dailyreleases/reddit.py
Normal file
24
dailyreleases/reddit.py
Normal file
|
@ -0,0 +1,24 @@
|
|||
import logging
|
||||
|
||||
import praw
|
||||
import praw.models.reddit.submission
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Reddit(object):
|
||||
def __init__(self, config) -> None:
|
||||
self.config = config
|
||||
|
||||
logger.info("Logging in to reddit")
|
||||
self.praw = praw.Reddit(**self.config["reddit"])
|
||||
|
||||
def send_pm(self, recipient, title, text):
|
||||
return self.praw.redditor(recipient).message(title, text)
|
||||
|
||||
def submit_post(self, title, text, subreddit):
|
||||
logger.info("Submitting post to r/%s", subreddit)
|
||||
return self.praw.subreddit(subreddit).submit(title, text)
|
||||
|
||||
def get_previous_daily_post(self, subreddit) -> praw.models.reddit.submission.Submission:
|
||||
return next(self.praw.subreddit(subreddit).search("daily release", sort="new", time_filter="week"))
|
70
dailyreleases/steam.py
Normal file
70
dailyreleases/steam.py
Normal file
|
@ -0,0 +1,70 @@
|
|||
import logging
|
||||
|
||||
from fuzzywuzzy import process, fuzz
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Steam(object):
|
||||
def __init__(self, config, cache) -> None:
|
||||
self.config = config
|
||||
self.cache = cache
|
||||
|
||||
def appdetails(self, appid):
|
||||
payload = {
|
||||
"appids": appid
|
||||
}
|
||||
r = self.cache.get("https://store.steampowered.com/api/appdetails", params=payload)
|
||||
return r.json()[appid]["data"]
|
||||
|
||||
def packagedetails(self, appid):
|
||||
payload = {
|
||||
"packageids": appid
|
||||
}
|
||||
r = self.cache.get("https://store.steampowered.com/api/packagedetails", params=payload)
|
||||
return r.json()[appid]["data"]
|
||||
|
||||
def appreviews(self, appid):
|
||||
payload = {
|
||||
"start_date": -1,
|
||||
"end_date": -1,
|
||||
"filter": "summary",
|
||||
"language": "all",
|
||||
"purchase_type": "all",
|
||||
"json": 1
|
||||
}
|
||||
r = self.cache.get(f"https://store.steampowered.com/appreviews/{appid}", params=payload)
|
||||
return r.json()["query_summary"]
|
||||
|
||||
def review_score(self, appid):
|
||||
app_review = self.appreviews(appid)
|
||||
if app_review["total_reviews"] == 0:
|
||||
return -1
|
||||
return app_review["total_positive"] / app_review["total_reviews"]
|
||||
|
||||
def popularity(self, appid):
|
||||
return self.appreviews(appid)["total_reviews"]
|
||||
|
||||
def eula(self, appid):
|
||||
return self.cache.get(f"https://store.steampowered.com//eula/{appid}_eula_0").text
|
||||
|
||||
def search(self, query):
|
||||
logger.debug("Searching Steam store for %s", query)
|
||||
payload = {
|
||||
"term": query
|
||||
}
|
||||
results = self.cache.get("https://store.steampowered.com/api/storesearch", params=payload).json()["items"]
|
||||
|
||||
best_match = process.extractOne(query,
|
||||
[r["name"] for r in results],
|
||||
scorer=fuzz.ratio, # could also use 'fuzz.token_sort_ratio'?
|
||||
score_cutoff=90)
|
||||
|
||||
if not best_match:
|
||||
logger.debug("Unable to find %s in Steam search results", query)
|
||||
return
|
||||
|
||||
logger.debug("Best match is '%s' with score %s", *best_match)
|
||||
return next(f"https://store.steampowered.com/{r['type']}/{r['id']}"
|
||||
for r in results
|
||||
if r["name"] == best_match[0])
|
31
dailyreleases/web.py
Normal file
31
dailyreleases/web.py
Normal file
|
@ -0,0 +1,31 @@
|
|||
import logging
|
||||
|
||||
import requests
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
||||
class Web(object):
|
||||
def __init__(self, config, cache) -> None:
|
||||
self.config = config
|
||||
self.cache = cache
|
||||
|
||||
def search(self, query) -> list:
|
||||
try:
|
||||
return self._google_search(query)
|
||||
except (KeyError, requests.RequestException) as e:
|
||||
logger.exception(e)
|
||||
logger.warning("Google search failed (probably rate-limited)")
|
||||
return []
|
||||
|
||||
def _google_search(self, query) -> list:
|
||||
logger.debug("Searching Google for %s", query)
|
||||
|
||||
payload = {
|
||||
"key": self.config["google"]["key"],
|
||||
"cx": self.config["google"]["cx"],
|
||||
"q": query
|
||||
}
|
||||
r = self.cache.get("https://www.googleapis.com/customsearch/v1", params=payload)
|
||||
|
||||
return [result["link"] for result in r.json()["items"]]
|
52
setup.py
Normal file
52
setup.py
Normal file
|
@ -0,0 +1,52 @@
|
|||
# Always prefer setuptools over distutils
|
||||
from setuptools import setup, find_packages
|
||||
# To use a consistent encoding
|
||||
from codecs import open
|
||||
from os import path
|
||||
|
||||
from dailyreleases import __author__, __version__, __licence__
|
||||
|
||||
here = path.abspath(path.dirname(__file__))
|
||||
|
||||
# Get the long description from the README file
|
||||
with open(path.join(here, "README.md"), encoding="utf-8") as f:
|
||||
long_description = f.read()
|
||||
|
||||
setup(
|
||||
name="dailyreleases",
|
||||
version=__version__,
|
||||
description="A reddit bot that consolidates scene releases",
|
||||
long_description=long_description,
|
||||
long_description_content_type="text/markdown",
|
||||
project_urls={
|
||||
"Source": "https://git.caspervk.net/caspervk/dailyreleases.git"
|
||||
},
|
||||
author=__author__,
|
||||
classifiers=[
|
||||
"Development Status :: 3 - Alpha",
|
||||
"License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
|
||||
"Programming Language :: Python :: 3",
|
||||
],
|
||||
python_requires=">=3.6",
|
||||
license=__licence__,
|
||||
packages=find_packages(exclude=["tests"]),
|
||||
include_package_data=True,
|
||||
package_data={
|
||||
"dailyreleases": [
|
||||
"*.default"
|
||||
]
|
||||
},
|
||||
install_requires=[
|
||||
"requests",
|
||||
"requests_cache",
|
||||
"praw",
|
||||
"beautifulsoup4",
|
||||
"tabulate",
|
||||
"fuzzywuzzy[speedup]"
|
||||
],
|
||||
entry_points={
|
||||
"console_scripts": [
|
||||
"dailyreleases = dailyreleases.main:main"
|
||||
]
|
||||
},
|
||||
)
|
0
tests/__init__.py
Normal file
0
tests/__init__.py
Normal file
144
tests/test_parse_dirname.py
Normal file
144
tests/test_parse_dirname.py
Normal file
|
@ -0,0 +1,144 @@
|
|||
import unittest
|
||||
|
||||
from dailyreleases.main import DailyReleasesBot
|
||||
|
||||
|
||||
class ParseDirnameTestCase(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.bot = DailyReleasesBot()
|
||||
|
||||
def test_single_word_release(self):
|
||||
p = self.bot.parse_dirname("Aztez-DARKSiDERS")
|
||||
|
||||
self.assertEqual("Aztez-DARKSiDERS", p["dirname"])
|
||||
self.assertEqual("Aztez", p["rls_name"])
|
||||
self.assertEqual("Aztez", p["game_name"])
|
||||
self.assertEqual("Windows", p["platform"])
|
||||
self.assertEqual("Games", p["type"])
|
||||
self.assertEqual("DARKSiDERS", p["group"])
|
||||
self.assertIn("store.steampowered.com/app/244750", p["store_link"])
|
||||
self.assertEqual("Steam", p["store_name"])
|
||||
self.assertEqual([], p["tags"])
|
||||
self.assertEqual([], p["highlights"])
|
||||
|
||||
def test_nuked_release(self):
|
||||
# TODO: Actual nuke handling?
|
||||
p = self.bot.parse_dirname("Battlefield.1-CPY")
|
||||
self.assertEqual("Battlefield.1-CPY", p["dirname"])
|
||||
|
||||
def test_update(self):
|
||||
p = self.bot.parse_dirname("Car.Mechanic.Simulator.2018.Plymouth.Update.v1.5.1.Hotfix-PLAZA")
|
||||
self.assertEqual("Updates", p["type"])
|
||||
|
||||
def test_proper_highlight(self):
|
||||
p = self.bot.parse_dirname("Death.Coming.PROPER-SiMPLEX")
|
||||
self.assertEqual(["PROPER"], p["highlights"])
|
||||
|
||||
def test_macos_release(self):
|
||||
p = self.bot.parse_dirname("The_Fall_Part_2_Unbound_MacOS-Razor1911")
|
||||
self.assertEqual("Mac OSX", p["platform"])
|
||||
self.assertEqual("Games", p["type"])
|
||||
|
||||
def test_macosx_update(self):
|
||||
p = self.bot.parse_dirname("Man_O_War_Corsair_Warhammer_Naval_Battles_v1.3.2_MacOSX-Razor1911")
|
||||
self.assertEqual("Mac OSX", p["platform"])
|
||||
self.assertEqual("Updates", p["type"])
|
||||
|
||||
def test_linux_release(self):
|
||||
p = self.bot.parse_dirname("Sphinx_And_The_Cursed_Mummy_Linux-Razor1911")
|
||||
self.assertEqual("Linux", p["platform"])
|
||||
self.assertEqual("Games", p["type"])
|
||||
|
||||
def test_dlc_explicit(self):
|
||||
p = self.bot.parse_dirname("Fallout.4.Far.Harbor.DLC-CODEX")
|
||||
self.assertEqual("DLC", p["type"])
|
||||
|
||||
def test_dlc_implicit(self):
|
||||
p = self.bot.parse_dirname("Euro.Truck.Simulator.2.Italia-CODEX")
|
||||
self.assertEqual("DLC", p["type"])
|
||||
self.assertIn("store.steampowered.com/app/558244", p["store_link"])
|
||||
|
||||
def test_incl_dlc_update(self):
|
||||
p = self.bot.parse_dirname("Wolfenstein.II.The.New.Colossus.Update.5.incl.DLC-CODEX")
|
||||
self.assertEqual("Updates", p["type"])
|
||||
|
||||
def test_incl_dlc_release(self):
|
||||
p = self.bot.parse_dirname("Mutiny.Incl.DLC-DARKSiDERS")
|
||||
self.assertEqual("Games", p["type"])
|
||||
|
||||
def test_popularity_steam(self):
|
||||
p1 = self.bot.parse_dirname("BioShock_Infinite-FLT")
|
||||
p2 = self.bot.parse_dirname("Duke.Nukem.Forever.Complete-PLAZA")
|
||||
self.assertGreater(p1["popularity"], p2["popularity"])
|
||||
|
||||
def test_non_steam(self):
|
||||
p = self.bot.parse_dirname("Battlefield.1.REPACK-CPY")
|
||||
self.assertIn("www.origin.com/usa/en-us/store/battlefield/battlefield-1", p["store_link"])
|
||||
self.assertEqual("Origin", p["store_name"])
|
||||
self.assertEqual(-1, p["popularity"])
|
||||
|
||||
def test_gog_exclusive(self):
|
||||
p = self.bot.parse_dirname("Dungeons.and.Dragons.Dragonshard.v2.0.0.10.Multilingual-DELiGHT")
|
||||
self.assertIn("gog.com/game/dungeons_dragons_dragonshard", p["store_link"])
|
||||
self.assertEqual("GOG", p["store_name"])
|
||||
self.assertEqual(-1, p["popularity"])
|
||||
|
||||
def test_popularity_non_steam(self):
|
||||
p = self.bot.parse_dirname("Ode.RIP.MULTI12-SiMPLEX")
|
||||
self.assertEqual(-1, p["popularity"])
|
||||
|
||||
def test_tags(self):
|
||||
p = self.bot.parse_dirname("Teenage.Mutant.Ninja.Turtles.Portal.Power.RIP.MULTI8-SiMPLEX")
|
||||
self.assertEqual(["RIP", "MULTI8"], p["tags"])
|
||||
|
||||
def test_skip_software(self):
|
||||
p = self.bot.parse_dirname("Tecplot.RS.2017.R1.v1.2.85254.X64-AMPED")
|
||||
self.assertIsNone(p)
|
||||
|
||||
def test_steam_package(self):
|
||||
p = self.bot.parse_dirname("Farming.Simulator.17.Platinum.Edition.Update.v1.5.3-BAT")
|
||||
self.assertEqual("Farming Simulator 17 - Platinum Edition", p["game_name"])
|
||||
self.assertEqual("Updates", p["type"])
|
||||
self.assertIn("store.steampowered.com/sub/202103", p["store_link"])
|
||||
self.assertEqual("Steam", p["store_name"])
|
||||
|
||||
def test_steam_package_with_dlc_first(self):
|
||||
p = self.bot.parse_dirname("The.Witcher.3.Wild.Hunt.Game.of.The.Year.Edition-RELOADED")
|
||||
self.assertEqual("The Witcher 3: Wild Hunt - Game of the Year Edition", p["game_name"])
|
||||
self.assertEqual("Games", p["type"])
|
||||
self.assertIn("store.steampowered.com/sub/124923", p["store_link"])
|
||||
|
||||
def test_steam_bundle(self):
|
||||
p = self.bot.parse_dirname("Valve.Complete.Pack-FAKE")
|
||||
self.assertEqual("Valve.Complete.Pack-FAKE", p["dirname"])
|
||||
self.assertEqual("Valve Complete Pack", p["game_name"])
|
||||
self.assertEqual("Windows", p["platform"])
|
||||
self.assertEqual("Games", p["type"])
|
||||
self.assertIn("store.steampowered.com/bundle/232", p["store_link"])
|
||||
|
||||
def test_denuvo_eula(self):
|
||||
p = self.bot.parse_dirname("Deus.Ex.Mankind.Divided-CPY")
|
||||
self.assertIn("store.steampowered.com/app/337000", p["store_link"])
|
||||
self.assertEqual(["DENUVO"], p["highlights"])
|
||||
|
||||
def test_episode_release(self):
|
||||
p = self.bot.parse_dirname("Life.is.Strange.Before.the.Storm.Episode.3-CODEX")
|
||||
self.assertEqual("Life is Strange: Before the Storm Episode 3", p["game_name"])
|
||||
self.assertEqual("DLC", p["type"])
|
||||
self.assertIn("store.steampowered.com/app/704740", p["store_link"])
|
||||
|
||||
def test_season_and_episode_release(self):
|
||||
p = self.bot.parse_dirname("Minecraft.Story.Mode.Season.Two.Episode.5.MacOSX-RELOADED")
|
||||
self.assertEqual("Minecraft Story Mode Season Two Episode 5", p["game_name"])
|
||||
|
||||
def test_build_is_update(self):
|
||||
p = self.bot.parse_dirname("DUSK.Episode.1.Build.2.6-SKIDROW")
|
||||
self.assertEqual("Updates", p["type"])
|
||||
|
||||
def test_readnfo_microsoft_store(self):
|
||||
p = self.bot.parse_dirname("Zoo.Tycoon.Ultimate.Animal.Collection.READNFO-CODEX")
|
||||
self.assertIn("microsoft.com/en-us/p/zoo-tycoon-ultimate-animal-collection", p["store_link"])
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
45
tests/test_parse_releases.py
Normal file
45
tests/test_parse_releases.py
Normal file
|
@ -0,0 +1,45 @@
|
|||
import unittest
|
||||
from datetime import datetime, timedelta
|
||||
|
||||
from dailyreleases.main import DailyReleasesBot
|
||||
|
||||
|
||||
class ParseReleasesTestCase(unittest.TestCase):
|
||||
def setUp(self):
|
||||
self.bot = DailyReleasesBot()
|
||||
|
||||
def test_skip_already_posted(self):
|
||||
already_posted = {"Aztez-DARKSiDERS"}
|
||||
releases = {
|
||||
"Aztez-DARKSiDERS": ("nfo_link", datetime.now())
|
||||
}
|
||||
parsed_releases = self.bot.parse_releases(releases, already_posted)
|
||||
self.assertDictEqual(parsed_releases[0], dict())
|
||||
|
||||
def test_skip_blacklisted_word(self):
|
||||
already_posted = set()
|
||||
releases = {
|
||||
"Anthemion.Software.DialogBlocks.v5.15.LINUX.Incl.Keygen-AMPED": ("nfo_link", datetime.now())
|
||||
}
|
||||
parsed_releases = self.bot.parse_releases(releases, already_posted)
|
||||
self.assertDictEqual(parsed_releases[0], dict())
|
||||
|
||||
def test_skip_older_than_48hr(self):
|
||||
already_posted = set()
|
||||
releases = {
|
||||
"Aztez-DARKSiDERS": ("nfo_link", datetime.now() - timedelta(hours=50))
|
||||
}
|
||||
parsed_releases = self.bot.parse_releases(releases, already_posted)
|
||||
self.assertDictEqual(parsed_releases[0], dict())
|
||||
|
||||
def test_skip_no_data_for_software(self):
|
||||
already_posted = set()
|
||||
releases = {
|
||||
"Tecplot.RS.2017.R1.v1.2.85254.X64-AMPED": ("nfo_link", datetime.now())
|
||||
}
|
||||
parsed_releases = self.bot.parse_releases(releases, already_posted)
|
||||
self.assertDictEqual(parsed_releases[0], dict())
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
unittest.main()
|
Reference in a new issue