initial commit, MVP
|
@ -0,0 +1,5 @@
|
|||
.vscode
|
||||
__pycache__
|
||||
|
||||
# testing logos
|
||||
custom_logos
|
|
@ -0,0 +1,43 @@
|
|||
# build requirements
|
||||
FROM python:3.10.5-slim-bullseye AS builder
|
||||
|
||||
RUN apt-get -y update && \
|
||||
apt-get -y install --no-install-recommends \
|
||||
build-essential
|
||||
|
||||
ENV PATH=/root/.local/bin:$PATH
|
||||
COPY tilefy/requirements.txt /requirements.txt
|
||||
RUN pip install --upgrade pip && pip install --user -r requirements.txt
|
||||
|
||||
|
||||
# load in main image
|
||||
FROM python:3.10.5-slim-bullseye as tilefy
|
||||
ARG INSTALL_DEBUG
|
||||
ENV PYTHONUNBUFFERED 1
|
||||
|
||||
# copy build requirements
|
||||
COPY --from=builder /root/.local /root/.local
|
||||
ENV PATH=/root/.local/bin:$PATH
|
||||
|
||||
RUN apt-get clean && apt-get -y update && \
|
||||
apt-get -y install --no-install-recommends \
|
||||
ttf-bitstream-vera fonts-liberation && \
|
||||
rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# install debug tools for testing environment
|
||||
RUN if [ "$INSTALL_DEBUG" ] ; then \
|
||||
apt-get -y update && apt-get -y install --no-install-recommends \
|
||||
vim htop bmon net-tools iputils-ping procps \
|
||||
&& pip install --user ipython \
|
||||
; fi
|
||||
|
||||
RUN mkdir /data
|
||||
RUN mkdir /app
|
||||
|
||||
COPY tilefy /app
|
||||
WORKDIR /app
|
||||
|
||||
RUN chmod +x ./start.sh
|
||||
|
||||
VOLUME /data
|
||||
CMD ["./start.sh"]
|
|
@ -0,0 +1,674 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://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 <http://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
|
||||
<http://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
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
|
@ -0,0 +1,139 @@
|
|||
![Tilefy](assets/tilefy-banner.jpg?raw=true "Tilefy Banner")
|
||||
|
||||
<center><h1>Create beautiful tiles for your project</h1></center>
|
||||
|
||||
## Table of contents
|
||||
- [Core functionality](#core-functionality)
|
||||
- [Screenshots](#screenshots)
|
||||
- [Installation](#installation)
|
||||
- [Configuration](#configuration)
|
||||
- [API requests](#api-requests)
|
||||
- [Plugins](#plugins)
|
||||
- [Donate](#donate)
|
||||
|
||||
## Core functionality
|
||||
- Dynamically create and recreate PNG tiles
|
||||
- Showcase any project stats accessible over a public API
|
||||
- Customize to your liking with your branding and color scheme
|
||||
- Embed your tiles anywhere you can embed a image
|
||||
- Self Hosted with Docker
|
||||
|
||||
## Screenshots
|
||||
![home screenshot](assets/screenshot.png?raw=true "Tilefy Home Page")
|
||||
|
||||
## Installation
|
||||
Take a look at the example `docker-compose.yml` file provided. Tilefy depends on two containers:
|
||||
|
||||
### Tilefy
|
||||
Main Python application to create and serve your tiles, built with Flask.
|
||||
- Serves the interface on port `8000`
|
||||
- Needs a volume at **/data** to store your tiles, custom fonts and logos and your **tiles.yml** config file.
|
||||
- Set your Redis connection with the environment variables `REDIS_HOST` and `REDIS_PORT`.
|
||||
- Set the environment variable `TILEFY_HOST` to your full url from where you are hosting this application. Needed to build links and templates to embed your tiles. Don't add a trailing `/`.
|
||||
- Set your timezone with the `TZ` environment variable to configure the scheduler, defaults to *UTC*.
|
||||
|
||||
### Redis JSON
|
||||
Functions as a cache and holds the scheduler data storage and history.
|
||||
- Needs a volume at **/data** to store your configurations permanently.
|
||||
|
||||
## Configuration
|
||||
Create a yml config file where you have mounted your `/data/tiles.yml` folder. Take a look at the provided `tiles.example.yml` for the basic syntax. *tiles* is the top level key, list your tiles below. The main key of the tile is your slug and will become your url, so use no spaces or special characters.
|
||||
|
||||
### tile_name
|
||||
Give your tile a unique human readable name.
|
||||
|
||||
### background_color, font_color
|
||||
Hex color code for background and font, make sure to add the *""* to escape the *#* symbol.
|
||||
|
||||
### width, height
|
||||
Size of the tile in pixels.
|
||||
|
||||
### logos
|
||||
List of logos, get a list of pre installed logos:
|
||||
```bash
|
||||
docker exec -it tilefy ls logos
|
||||
```
|
||||
Add the pre installed logos by providing the file name. Contribute by adding additional commonly used logos.
|
||||
|
||||
Provide your custom logos by adding them to `/data/logos/`, in PNG file format with transparent background. Add your custom logos by providing a relative path like `logos/file-name.png`.
|
||||
|
||||
### font: optional
|
||||
Font defaults to *Vera.ttf*. Use a pre installed font from the *liberation* or *ttf-bitstream-vera* packages by providing the relative path from the truetype folder.
|
||||
List available pre installed fonts:
|
||||
```bash
|
||||
docker exec -it tilefy ls /usr/share/fonts/truetype/liberation
|
||||
docker exec -it tilefy ls /usr/share/fonts/truetype/ttf-bitstream-vera
|
||||
```
|
||||
|
||||
Provide your custom font by adding them to `/data/fonts`, in TTF format only and add them with their relative path like `fonts/font-name.ttf`.
|
||||
|
||||
### humanize: optional
|
||||
Defaults to `true` for all numbers. Shorten long numbers in to a more human readable string, like *14502* to *14.5K*.
|
||||
|
||||
### recreate: optional
|
||||
Recreate tiles periodically, provide your custom schedule as a cron tab or use `on_demand` to recreate the tile for every request. Defaults to `0 0 * * *` aka every day at midnight. Be aware of any rate limiting and API quotas you might face with a too frequent schedule.
|
||||
Note:
|
||||
- There is automatically a random jitter for cron tab of 15 secs to avoid parallel requests for a lot of tiles.
|
||||
- There is a failsafe in place to block recreating tiles faster than every 60 seconds.
|
||||
|
||||
## API requests
|
||||
Get values from a public API by providing the url and key_map.
|
||||
|
||||
### url
|
||||
JSON API endpoint. If you can, filter and reduce the API response size by requesting only the required fields.
|
||||
|
||||
### key_map
|
||||
Navigate the JSON object to find your desired value. Each item in the list navigates one level deeper, a `string` accesses a key and a `int` accesses an index in an array.
|
||||
|
||||
*Example 1*
|
||||
```json
|
||||
{
|
||||
"pull_count": 269912,
|
||||
"star_count": 11,
|
||||
}
|
||||
```
|
||||
To for example access the *pull_count* key in the top level of the response:
|
||||
```yml
|
||||
key_map:
|
||||
- pull_count
|
||||
```
|
||||
|
||||
*Example 2*
|
||||
```json
|
||||
{
|
||||
"results": [
|
||||
{
|
||||
"status": "success",
|
||||
"last_run": "timestamp",
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
To for example access the *status* key in the first dictionary of the results list:
|
||||
```yml
|
||||
key_map:
|
||||
- results
|
||||
- 0
|
||||
- status
|
||||
```
|
||||
|
||||
## Plugins
|
||||
For all values not accessible over a JSON API endpoint, this will need a dedicated solution by for example scraping the website. This is inherently less reliable as websites change more frequently than APIs.
|
||||
|
||||
### Chrome extension users
|
||||
Get the amount of active chrome extension users.
|
||||
```yml
|
||||
plugin:
|
||||
name: chrome-extension-users
|
||||
id: jjnkmicfnfojkkgobdfeieblocadmcie
|
||||
```
|
||||
|
||||
Please contribute and open feature requests to add more.
|
||||
|
||||
## Donate
|
||||
The best donation to **Tilefy** is your time, contribute in any way you can to improve this project.
|
||||
Second best way to support the development is to provide for caffeinated beverages:
|
||||
* [Paypal.me](https://paypal.me/bbilly1) for a one time coffee
|
||||
* [Paypal Subscription](https://www.paypal.com/webapps/billing/plans/subscribe?plan_id=P-03770005GR991451KMFGVPMQ) for a monthly coffee
|
||||
* [ko-fi.com](https://ko-fi.com/bbilly1) for an alternative platform
|
After Width: | Height: | Size: 110 KiB |
After Width: | Height: | Size: 45 KiB |
After Width: | Height: | Size: 41 KiB |
After Width: | Height: | Size: 56 KiB |
After Width: | Height: | Size: 38 KiB |
After Width: | Height: | Size: 86 KiB |
After Width: | Height: | Size: 36 KiB |
After Width: | Height: | Size: 54 KiB |
|
@ -0,0 +1,95 @@
|
|||
#!/bin/bash
|
||||
# deploy app
|
||||
|
||||
test_host="tilefy.local"
|
||||
|
||||
function rebuild_test {
|
||||
echo "rebuild testing environment"
|
||||
rsync -a --progress --delete-after \
|
||||
--exclude ".git" \
|
||||
--exclude ".gitignore" \
|
||||
--exclude "**/cache" \
|
||||
--exclude "**/__pycache__/" \
|
||||
--exclude "db.sqlite3" \
|
||||
. -e ssh "$test_host":tilefy
|
||||
|
||||
rsync --progress --ignore-existing docker-compose.yml -e ssh "$test_host":docker
|
||||
rsync --progress tiles.example.yml -e ssh "$test_host":docker/volume/tilefy/data/tiles.yml
|
||||
|
||||
ssh "$test_host" "docker buildx build --build-arg INSTALL_DEBUG=1 -t bbilly1/tilefy tilefy --load"
|
||||
ssh "$test_host" 'docker compose -f docker/docker-compose.yml up -d --build'
|
||||
}
|
||||
|
||||
function validate {
|
||||
|
||||
if [[ $1 ]]; then
|
||||
check_path="$1"
|
||||
else
|
||||
check_path="."
|
||||
fi
|
||||
|
||||
echo "run validate on $check_path"
|
||||
|
||||
echo "running black"
|
||||
black --diff --color --check -l 79 "$check_path"
|
||||
echo "running codespell"
|
||||
codespell --skip="./.git" "$check_path"
|
||||
echo "running flake8"
|
||||
flake8 "$check_path" --count --max-complexity=10 --max-line-length=79 \
|
||||
--show-source --statistics
|
||||
echo "running isort"
|
||||
isort --check-only --diff --profile black -l 79 "$check_path"
|
||||
printf " \n> all validations passed\n"
|
||||
|
||||
}
|
||||
|
||||
function docker_publish {
|
||||
|
||||
# check things
|
||||
if [[ $(git branch --show-current) != 'master' ]]; then
|
||||
echo 'you are not on master, dummy!'
|
||||
return
|
||||
fi
|
||||
|
||||
if [[ $(systemctl is-active docker) != 'active' ]]; then
|
||||
echo "starting docker"
|
||||
sudo systemctl start docker
|
||||
fi
|
||||
echo "latest tags:"
|
||||
git tag | tail -n 5 | sort -r
|
||||
|
||||
printf "\ncreate new version:\n"
|
||||
read -r VERSION
|
||||
|
||||
echo "build and push $VERSION?"
|
||||
read -rn 1
|
||||
|
||||
# start build
|
||||
sudo docker buildx build \
|
||||
--platform linux/amd64,linux/arm64 \
|
||||
-t bbilly1/tilefy \
|
||||
-t bbilly1/tilefy:"$VERSION" --push .
|
||||
|
||||
# create release tag
|
||||
echo "commits since last version:"
|
||||
git log "$(git describe --tags --abbrev=0)"..HEAD --oneline
|
||||
git tag -a "$VERSION" -m "new release version $VERSION"
|
||||
git push origin "$VERSION"
|
||||
|
||||
}
|
||||
|
||||
|
||||
if [[ $1 == "test" ]]; then
|
||||
rebuild_test
|
||||
elif [[ $1 == "validate" ]]; then
|
||||
# check package versions in requirements.txt for updates
|
||||
python version_check.py
|
||||
validate "$2"
|
||||
elif [[ $1 == "docker" ]]; then
|
||||
docker_publish
|
||||
else
|
||||
echo "valid options are: test | docker "
|
||||
fi
|
||||
|
||||
##
|
||||
exit 0
|
|
@ -0,0 +1,24 @@
|
|||
version: '3.3'
|
||||
|
||||
services:
|
||||
tilefy:
|
||||
container_name: tilefy
|
||||
restart: always
|
||||
image: bbilly1/tilefy
|
||||
volumes:
|
||||
- ./volume/tilefy/data:/data
|
||||
ports:
|
||||
- 8000:8000
|
||||
environment:
|
||||
- TZ=America/New_York
|
||||
- TILEFY_HOST=http://tilefy.local
|
||||
- REDIS_HOST=tilefy-redis
|
||||
- REDIS_PORT=6379
|
||||
tilefy-redis:
|
||||
image: redislabs/rejson
|
||||
container_name: tilefy-redis
|
||||
restart: always
|
||||
expose:
|
||||
- "6379"
|
||||
volumes:
|
||||
- ./volume/tilefy/redis:/data
|
After Width: | Height: | Size: 10 KiB |
After Width: | Height: | Size: 32 KiB |
After Width: | Height: | Size: 20 KiB |
After Width: | Height: | Size: 12 KiB |
After Width: | Height: | Size: 18 KiB |
|
@ -0,0 +1,8 @@
|
|||
APScheduler==3.9.1
|
||||
beautifulsoup4==4.11.1
|
||||
flask==2.1.2
|
||||
Pillow==9.1.1
|
||||
PyYAML==6.0
|
||||
redis==4.3.3
|
||||
requests==2.28.0
|
||||
uwsgi==2.0.20
|
|
@ -0,0 +1,78 @@
|
|||
"""make api call to get variable text"""
|
||||
|
||||
import requests
|
||||
from src.plugins.chrome_extension import ChromeExtension
|
||||
|
||||
|
||||
def humanize(number):
|
||||
"""humanize number to string"""
|
||||
|
||||
break_points = [
|
||||
(999999999, "B"),
|
||||
(999999, "M"),
|
||||
(999, "K"),
|
||||
]
|
||||
|
||||
for break_point in break_points:
|
||||
break_nr, break_str = break_point
|
||||
if number > break_nr:
|
||||
return f"{round(number / (break_nr + 1), 1)}{break_str}"
|
||||
|
||||
return str(number)
|
||||
|
||||
|
||||
class Api:
|
||||
"""make request and parse"""
|
||||
|
||||
def __init__(self, tile_config):
|
||||
self.tile_config = tile_config
|
||||
|
||||
def get_text(self):
|
||||
"""run all"""
|
||||
if "plugin" in self.tile_config:
|
||||
key_match = self.plugin()
|
||||
else:
|
||||
key_match = self.url()
|
||||
|
||||
to_humanize = self.tile_config.get("humanize", True)
|
||||
if not to_humanize or isinstance(key_match, str):
|
||||
return str(key_match)
|
||||
|
||||
return humanize(key_match)
|
||||
|
||||
def url(self):
|
||||
"""make call using url from tile_config"""
|
||||
response = self.make_request()
|
||||
key_match = self.walk_response(response)
|
||||
if not key_match:
|
||||
print(f"failed to result with key_map: {response}")
|
||||
raise ValueError
|
||||
|
||||
return key_match
|
||||
|
||||
def make_request(self):
|
||||
"""make request"""
|
||||
url = self.tile_config["url"]
|
||||
response = requests.get(url, timeout=1)
|
||||
if not response.ok:
|
||||
print(f"failed to make request: {url}")
|
||||
raise ValueError
|
||||
|
||||
return response.json()
|
||||
|
||||
def walk_response(self, response):
|
||||
"""walk response dict for key"""
|
||||
for item in self.tile_config["key_map"]:
|
||||
response = response[item]
|
||||
|
||||
return response
|
||||
|
||||
def plugin(self):
|
||||
"""make request with pugin"""
|
||||
plugin_name = self.tile_config["plugin"]["name"]
|
||||
item_id = self.tile_config["plugin"]["id"]
|
||||
if plugin_name == "chrome-extension-users":
|
||||
users = ChromeExtension(item_id).get()
|
||||
return users
|
||||
|
||||
raise ValueError("missing plugin")
|
|
@ -0,0 +1,38 @@
|
|||
"""scrape chrome extension users"""
|
||||
|
||||
import re
|
||||
|
||||
import requests
|
||||
from bs4 import BeautifulSoup
|
||||
|
||||
|
||||
class ChromeExtension:
|
||||
"""scrape chome extension for user number"""
|
||||
|
||||
def __init__(self, extension_id):
|
||||
self.extension_id = extension_id
|
||||
|
||||
def get(self):
|
||||
"""get parsed users"""
|
||||
soup = self.get_soup()
|
||||
users = self.parse_field(soup)
|
||||
|
||||
return users
|
||||
|
||||
def get_soup(self):
|
||||
"""get the soup"""
|
||||
url = (
|
||||
"https://chrome.google.com/webstore/detail/"
|
||||
+ f"{self.extension_id}?hl=en&authuser=0"
|
||||
)
|
||||
response = requests.get(url).text
|
||||
soup = BeautifulSoup(response, "html.parser")
|
||||
|
||||
return soup
|
||||
|
||||
def parse_field(self, soup):
|
||||
"""extract the number"""
|
||||
char_field = soup.find("span", {"class": "e-f-ih"}).text
|
||||
users = int(re.sub(r"[^\d]+", "", char_field))
|
||||
|
||||
return users
|
|
@ -0,0 +1,75 @@
|
|||
"""configure scheduled jobs"""
|
||||
|
||||
from os import environ
|
||||
|
||||
from apscheduler.schedulers.background import BackgroundScheduler
|
||||
from apscheduler.triggers.cron import CronTrigger
|
||||
from src.template import create_single_tile
|
||||
from src.tilefy_redis import TilefyRedis
|
||||
|
||||
|
||||
class TilefyScheduler:
|
||||
"""interact with scheduler"""
|
||||
|
||||
CRON_DEFAULT = "0 0 * * *"
|
||||
|
||||
def __init__(self):
|
||||
self.scheduler = False
|
||||
self.tiles = False
|
||||
|
||||
def setup_schedule(self):
|
||||
"""startup"""
|
||||
config = TilefyRedis().get_message("config")
|
||||
if not config:
|
||||
print("no tiles defined in tiles.yml")
|
||||
return
|
||||
|
||||
self.tiles = config["tiles"]
|
||||
self.scheduler = BackgroundScheduler(timezone=environ.get("TZ", "UTC"))
|
||||
self.add_job_store()
|
||||
jobs = self.build_jobs()
|
||||
self.add_jobs(jobs)
|
||||
|
||||
self.scheduler.start()
|
||||
|
||||
def add_job_store(self):
|
||||
"""add jobstore to scheudler"""
|
||||
self.scheduler.add_jobstore(
|
||||
"redis",
|
||||
jobs_key="tl:jobs",
|
||||
run_times_key="tl:run_times",
|
||||
host=environ.get("REDIS_HOST"),
|
||||
port=environ.get("REDIS_PORT"),
|
||||
)
|
||||
|
||||
def build_jobs(self):
|
||||
"""build list of expected jobs"""
|
||||
jobs = []
|
||||
for idx, (tile_slug, tile_conf) in enumerate(self.tiles.items()):
|
||||
job = {
|
||||
"job_id": str(idx),
|
||||
"job_name": tile_slug,
|
||||
"tile_conf": tile_conf,
|
||||
}
|
||||
jobs.append(job)
|
||||
|
||||
return jobs
|
||||
|
||||
def add_jobs(self, jobs):
|
||||
"""add jobs to scheduler"""
|
||||
for job in jobs:
|
||||
cron_tab = job["tile_conf"].get("recreate", self.CRON_DEFAULT)
|
||||
if cron_tab == "on_demand":
|
||||
continue
|
||||
|
||||
job_name = job["job_name"]
|
||||
self.scheduler.add_job(
|
||||
create_single_tile,
|
||||
CronTrigger.from_crontab(cron_tab),
|
||||
id=job["job_id"],
|
||||
name=job_name,
|
||||
args=[job_name, job["tile_conf"]],
|
||||
jitter=15,
|
||||
replace_existing=True,
|
||||
)
|
||||
print(f"{job_name}: Add job {cron_tab}")
|
|
@ -0,0 +1,126 @@
|
|||
"""create from template"""
|
||||
|
||||
from datetime import datetime
|
||||
from os import path
|
||||
|
||||
from PIL import Image, ImageDraw, ImageFont
|
||||
from src.api_call import Api
|
||||
from src.tilefy_redis import TilefyRedis
|
||||
|
||||
|
||||
class TileImage:
|
||||
"""interact with tile object"""
|
||||
|
||||
TILE_BASE = "/data/tiles"
|
||||
FONT_DEFAULT = "/usr/share/fonts/truetype/ttf-bitstream-vera/Vera.ttf"
|
||||
|
||||
def __init__(self, tile_slug, tile_config):
|
||||
self.tile_slug = tile_slug
|
||||
self.tile_config = tile_config
|
||||
self.content_height = self.tile_config["height"] // 3 * 2
|
||||
self.img = False
|
||||
|
||||
def build_tile(self):
|
||||
"""create the tile"""
|
||||
print(f"{self.tile_slug}: {self.tile_config}")
|
||||
self.create_background()
|
||||
right = self.add_logos()
|
||||
self.add_text(right)
|
||||
self.save_tile()
|
||||
|
||||
def create_background(self):
|
||||
"""create the background"""
|
||||
size = (self.tile_config["width"], self.tile_config["height"])
|
||||
color = self.tile_config["background_color"]
|
||||
self.img = Image.new(mode="RGBA", size=size, color=color)
|
||||
|
||||
def _get_logo(self, logo_path):
|
||||
"""return logo pillow object"""
|
||||
if logo_path.startswith("logos/"):
|
||||
# custom logo
|
||||
file_path = path.join("/data", logo_path)
|
||||
else:
|
||||
# default logo
|
||||
file_path = path.join("logos", logo_path)
|
||||
|
||||
logo = Image.open(file_path)
|
||||
logo.thumbnail((self.content_height, self.content_height))
|
||||
|
||||
return logo.convert("RGBA")
|
||||
|
||||
def add_logos(self):
|
||||
"""add logos to img"""
|
||||
logo_paths = self.tile_config["logos"]
|
||||
if not logo_paths:
|
||||
return False
|
||||
|
||||
top = (self.tile_config["height"] - self.content_height) // 2
|
||||
for idx, logo_path in enumerate(logo_paths):
|
||||
logo = self._get_logo(logo_path)
|
||||
left = top + self.content_height * idx
|
||||
right = left + self.content_height
|
||||
self.img.alpha_composite(logo, dest=(left, top))
|
||||
|
||||
return right
|
||||
|
||||
def add_text(self, right):
|
||||
"""write text on tile"""
|
||||
draw = ImageDraw.Draw(self.img)
|
||||
# font
|
||||
font_color = self.tile_config["font_color"]
|
||||
font_path = self._get_font_path()
|
||||
font = ImageFont.truetype(font_path, int(self.content_height * 0.9))
|
||||
# size
|
||||
width = self.tile_config["width"]
|
||||
left = width - (width - right) // 2
|
||||
top = self.tile_config["height"] // 2
|
||||
# text
|
||||
text = Api(self.tile_config).get_text()
|
||||
print(f"{self.tile_slug}: tile response {text}")
|
||||
draw.text((left, top), text, fill=font_color, anchor="mm", font=font)
|
||||
|
||||
def _get_font_path(self):
|
||||
"""build path to font"""
|
||||
font_conf = self.tile_config.get("font")
|
||||
if not font_conf:
|
||||
return self.FONT_DEFAULT
|
||||
|
||||
if font_conf.startswith("liberation"):
|
||||
return path.join("/usr/share/fonts/truetype", font_conf)
|
||||
|
||||
if font_conf.startswith("ttf-bitstream-vera"):
|
||||
return path.join("/usr/share/fonts/truetype", font_conf)
|
||||
|
||||
if font_conf.startswith("fonts/"):
|
||||
return path.join("/data", font_conf)
|
||||
|
||||
return self.FONT_DEFAULT
|
||||
|
||||
def save_tile(self):
|
||||
"""save tile to disk"""
|
||||
file_path = path.join(self.TILE_BASE, self.tile_slug + ".png")
|
||||
self.img.save(file_path)
|
||||
|
||||
|
||||
def create_all_tiles():
|
||||
"""create all tiles needed"""
|
||||
config = TilefyRedis().get_message("config")
|
||||
if not config:
|
||||
print("no tiles defined in tiles.yml")
|
||||
return
|
||||
|
||||
for tile_slug, tile_config in config["tiles"].items():
|
||||
create_single_tile(tile_slug, tile_config)
|
||||
|
||||
|
||||
def create_single_tile(tile_slug, tile_config):
|
||||
"""create a single tile"""
|
||||
key = f"lock:{tile_slug}"
|
||||
locked = TilefyRedis().get_message(key)
|
||||
if locked:
|
||||
print(f"{tile_slug}: skip rebuild within 60secs")
|
||||
return
|
||||
|
||||
TileImage(tile_slug, tile_config).build_tile()
|
||||
message = {"recreate": int(datetime.now().strftime("%s"))}
|
||||
TilefyRedis().set_message(key, message, expire=60)
|
|
@ -0,0 +1,56 @@
|
|||
"""handle redis integration"""
|
||||
|
||||
import json
|
||||
import os
|
||||
|
||||
import redis
|
||||
import yaml
|
||||
|
||||
TILES_CONFIG = "/data/tiles.yml"
|
||||
|
||||
|
||||
class RedisBase:
|
||||
"""connection base for redis"""
|
||||
|
||||
REDIS_HOST = os.environ.get("REDIS_HOST")
|
||||
REDIS_PORT = os.environ.get("REDIS_PORT") or 6379
|
||||
NAME_SPACE = "tl:"
|
||||
|
||||
def __init__(self):
|
||||
self.conn = redis.Redis(host=self.REDIS_HOST, port=self.REDIS_PORT)
|
||||
|
||||
|
||||
class TilefyRedis(RedisBase):
|
||||
"""interact with redis"""
|
||||
|
||||
def set_message(self, key, message, expire=False):
|
||||
"""set new message"""
|
||||
self.conn.execute_command(
|
||||
"JSON.SET", self.NAME_SPACE + key, ".", json.dumps(message)
|
||||
)
|
||||
if expire:
|
||||
self.conn.execute_command("EXPIRE", self.NAME_SPACE + key, expire)
|
||||
|
||||
def get_message(self, key, path="."):
|
||||
"""get message from redis"""
|
||||
reply = self.conn.execute_command(
|
||||
"JSON.GET", self.NAME_SPACE + key, path
|
||||
)
|
||||
if reply:
|
||||
return json.loads(reply)
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def load_yml():
|
||||
"""read yml file"""
|
||||
|
||||
if not os.path.exists(TILES_CONFIG):
|
||||
print("missing tiles.yml")
|
||||
return
|
||||
|
||||
with open(TILES_CONFIG, "r", encoding="utf-8") as yml_file:
|
||||
file_content = yml_file.read()
|
||||
config_raw = yaml.load(file_content, Loader=yaml.CLoader)
|
||||
|
||||
TilefyRedis().set_message("config", config_raw)
|
|
@ -0,0 +1,6 @@
|
|||
#!/bin/bash
|
||||
# container start up script
|
||||
|
||||
mkdir -p /data/{"tiles","logos","fonts"}
|
||||
|
||||
uwsgi --ini uwsgi.ini
|
|
@ -0,0 +1,95 @@
|
|||
Copyright (c) 2010-2013 by tyPoland Lukasz Dziedzic with Reserved Font Name "Carlito".
|
||||
|
||||
This Font Software is licensed under the SIL Open Font License,
|
||||
Version 1.1 as shown below.
|
||||
|
||||
SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
|
||||
|
||||
PREAMBLE The goals of the Open Font License (OFL) are to stimulate
|
||||
worldwide development of collaborative font projects, to support the font
|
||||
creation efforts of academic and linguistic communities, and to provide
|
||||
a free and open framework in which fonts may be shared and improved in
|
||||
partnership with others.
|
||||
|
||||
The OFL allows the licensed fonts to be used, studied, modified and
|
||||
redistributed freely as long as they are not sold by themselves.
|
||||
The fonts, including any derivative works, can be bundled, embedded,
|
||||
redistributed and/or sold with any software provided that any reserved
|
||||
names are not used by derivative works. The fonts and derivatives,
|
||||
however, cannot be released under any other type of license. The
|
||||
requirement for fonts to remain under this license does not apply to
|
||||
any document created using the fonts or their derivatives.
|
||||
|
||||
|
||||
DEFINITIONS
|
||||
"Font Software" refers to the set of files released by the Copyright
|
||||
Holder(s) under this license and clearly marked as such.
|
||||
This may include source files, build scripts and documentation.
|
||||
|
||||
"Reserved Font Name" refers to any names specified as such after the
|
||||
copyright statement(s).
|
||||
|
||||
"Original Version" refers to the collection of Font Software components
|
||||
as distributed by the Copyright Holder(s).
|
||||
|
||||
"Modified Version" refers to any derivative made by adding to, deleting,
|
||||
or substituting ? in part or in whole ?
|
||||
any of the components of the Original Version, by changing formats or
|
||||
by porting the Font Software to a new environment.
|
||||
|
||||
"Author" refers to any designer, engineer, programmer, technical writer
|
||||
or other person who contributed to the Font Software.
|
||||
|
||||
|
||||
PERMISSION & CONDITIONS
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a
|
||||
copy of the Font Software, to use, study, copy, merge, embed, modify,
|
||||
redistribute, and sell modified and unmodified copies of the Font
|
||||
Software, subject to the following conditions:
|
||||
|
||||
1) Neither the Font Software nor any of its individual components,in
|
||||
Original or Modified Versions, may be sold by itself.
|
||||
|
||||
2) Original or Modified Versions of the Font Software may be bundled,
|
||||
redistributed and/or sold with any software, provided that each copy
|
||||
contains the above copyright notice and this license. These can be
|
||||
included either as stand-alone text files, human-readable headers or
|
||||
in the appropriate machine-readable metadata fields within text or
|
||||
binary files as long as those fields can be easily viewed by the user.
|
||||
|
||||
3) No Modified Version of the Font Software may use the Reserved Font
|
||||
Name(s) unless explicit written permission is granted by the
|
||||
corresponding Copyright Holder. This restriction only applies to the
|
||||
primary font name as presented to the users.
|
||||
|
||||
4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
|
||||
Software shall not be used to promote, endorse or advertise any
|
||||
Modified Version, except to acknowledge the contribution(s) of the
|
||||
Copyright Holder(s) and the Author(s) or with their explicit written
|
||||
permission.
|
||||
|
||||
5) The Font Software, modified or unmodified, in part or in whole, must
|
||||
be distributed entirely under this license, and must not be distributed
|
||||
under any other license. The requirement for fonts to remain under
|
||||
this license does not apply to any document created using the Font
|
||||
Software.
|
||||
|
||||
|
||||
|
||||
TERMINATION
|
||||
This license becomes null and void if any of the above conditions are not met.
|
||||
|
||||
|
||||
|
||||
DISCLAIMER
|
||||
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
||||
OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
|
||||
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER
|
||||
DEALINGS IN THE FONT SOFTWARE.
|
||||
|
After Width: | Height: | Size: 12 KiB |
After Width: | Height: | Size: 41 KiB |
|
@ -0,0 +1,12 @@
|
|||
|
||||
// set background color for preview boxes
|
||||
function colorPreview() {
|
||||
const allPreviews = document.getElementsByClassName("color-preview");
|
||||
for (let i = 0; i < allPreviews.length; i++) {
|
||||
const previewElement = allPreviews[i];
|
||||
const backgroundColor = previewElement.getAttribute("data-id")
|
||||
previewElement.style.backgroundColor = backgroundColor
|
||||
}
|
||||
}
|
||||
|
||||
colorPreview();
|
|
@ -0,0 +1,140 @@
|
|||
:root {
|
||||
--main-bg: #272d32;
|
||||
--bg-alt: #171717;
|
||||
--accent-1: #e5b534;
|
||||
--accent-2: #f47834;
|
||||
--accent-3: #da2934;
|
||||
--font-main: #c1c1c1;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'CarlitoRegular';
|
||||
src: url('/static/font/CarlitoRegular.woff');
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'CarlitoItalic';
|
||||
src: url('/static/font/CarlitoItalic.woff');
|
||||
font-weight: normal;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
@font-face {
|
||||
font-family: 'CarlitoBold';
|
||||
src: url('/static/font/CarlitoBold.woff');
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
* {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
html {
|
||||
height: 100%;
|
||||
}
|
||||
|
||||
body {
|
||||
background-color: var(--main-bg);
|
||||
min-height: 100%;
|
||||
display: grid;
|
||||
grid-template-rows: 1fr auto;
|
||||
}
|
||||
|
||||
h1 {
|
||||
color: var(--accent-1);
|
||||
font-family: CarlitoBold, serif;
|
||||
text-align: center;
|
||||
font-size: 2.2rem;
|
||||
margin-top: 20px;
|
||||
}
|
||||
|
||||
h2 {
|
||||
color: var(--accent-2);
|
||||
font-family: CarlitoBold, serif;
|
||||
font-weight: bold;
|
||||
font-size: 2rem;
|
||||
margin: 20px 0 5px 0;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-family: CarlitoItalic, sans-serif;
|
||||
color: var(--accent-3);
|
||||
font-size: 1.4rem;
|
||||
}
|
||||
|
||||
p, a, span {
|
||||
font-family: CarlitoRegular, sans-serif;
|
||||
color: var(--font-main);
|
||||
font-size: 1.2rem;
|
||||
}
|
||||
|
||||
.boxed-content {
|
||||
max-width: 1000px;
|
||||
width: 80%;
|
||||
margin: 0 auto;
|
||||
}
|
||||
|
||||
.footer {
|
||||
margin: 0;
|
||||
padding: 20px 0;
|
||||
background-color: var(--bg-alt);
|
||||
grid-row-start: 2;
|
||||
grid-row-end: 3;
|
||||
}
|
||||
|
||||
.banner {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.banner img {
|
||||
width: 80%;
|
||||
}
|
||||
|
||||
.tile-meta {
|
||||
display: grid;
|
||||
grid-template-columns: 1fr 1fr;
|
||||
}
|
||||
|
||||
.tile {
|
||||
padding: 1rem;
|
||||
margin: 1rem 0;
|
||||
background-color: var(--bg-alt);
|
||||
}
|
||||
|
||||
.tile-preview {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.tile-preview img {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.color-box {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.color-item {
|
||||
display: flex;
|
||||
flex: 1;
|
||||
align-items: center;
|
||||
}
|
||||
|
||||
.color-preview {
|
||||
width: 70px;
|
||||
height: 40px;
|
||||
background-color: white;
|
||||
margin-right: 1rem;
|
||||
}
|
||||
|
||||
.tile-links {
|
||||
margin-top: 1rem;
|
||||
}
|
||||
|
||||
.tile-link-item {
|
||||
padding: 5px 0;
|
||||
}
|
|
@ -0,0 +1,76 @@
|
|||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<link rel="shortcut icon" href="/static/img/favicon.ico">
|
||||
<link rel="stylesheet" href="/static/style.css">
|
||||
<title>Tilefy Home</title>
|
||||
</head>
|
||||
<body>
|
||||
<div class="main-content">
|
||||
<div class="boxed-content">
|
||||
<div class="banner">
|
||||
<img src="/static/img/tilefy-banner.png" alt="tilefy banner">
|
||||
</div>
|
||||
<h1>Create Beautiful Tiles for your Project</h1>
|
||||
<div class="tiles">
|
||||
{% if tiles %}
|
||||
{% for tile in tiles %}
|
||||
<div class="tile">
|
||||
<div class="tile-preview">
|
||||
<img src="/t/{{ tile.tile_slug }}.png" alt="{{ tile.tile_slug }} preview">
|
||||
</div>
|
||||
<div class="tile-meta">
|
||||
<div>
|
||||
<h2>{{ tile.tile_name }}</h2>
|
||||
<p>{{ tile.height }} x {{ tile.width }} px</p>
|
||||
</div>
|
||||
<div class="color-box">
|
||||
<div class="color-item">
|
||||
<div class="color-preview" data-id="{{ tile.background_color }}">
|
||||
</div>
|
||||
<p>Background Color</p>
|
||||
</div>
|
||||
<div class="color-item">
|
||||
<div class="color-preview" data-id="{{ tile.font_color }}">
|
||||
</div>
|
||||
<p>Font Color</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tile-links">
|
||||
<div class="tile-link-item">
|
||||
<h3>URL</h3>
|
||||
<a href="{{ host_name }}/t/{{ tile.tile_slug }}.png">{{ host_name }}/t/{{ tile.tile_slug }}.png</a>
|
||||
</div>
|
||||
<div class="tile-link-item">
|
||||
<h3>HTML</h3>
|
||||
<p>{{ '<a href="https://www.tilefy.me" target="_blank"><img src="' }}{{ host_name }}/t/{{ tile.tile_slug }}.png{{ '" alt="' }}{{ tile.tile_slug }}{{ '" title="' }}{{ tile.tile_name }}{{ '" height="' }}{{ tile.height // 2 }}{{ '" width="' }}{{ tile.width // 2 }}{{ '"/></a>' }}</p>
|
||||
</div>
|
||||
<div class="tile-link-item">
|
||||
<h3>Markdown</h3>
|
||||
<p>[![{{ tile.tile_slug }}]({{ host_name }}/t/{{ tile.tile_slug }}.png)](https://www.tilefy.me)
|
||||
</div>
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
{% endfor %}
|
||||
{% else %}
|
||||
<div class="tile banner">
|
||||
<p>No tiles defined in <i>tiles.yml</i>.</p>
|
||||
<p>Take a look at the Readme on Github to get started: <a href="https://github.com/bbilly1/tilefy" target="_blank">https://github.com/bbilly1/tilefy</a></p>
|
||||
</div>
|
||||
{% endif %}
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
<div class="boxed-content">
|
||||
<span>© <script type="text/javascript">document.write(new Date().getFullYear());</script> Tilefy v0.0.1 </span><span><a href="https://github.com/bbilly1/tilefy" target="_blank">GitHub</a> | <a href="https://hub.docker.com/r/bbilly1/tilefy" target="_blank">Docker Hub</a></span>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript" src="/static/script.js"></script>
|
||||
</body>
|
||||
</html>
|
|
@ -0,0 +1,10 @@
|
|||
[uwsgi]
|
||||
callable = app
|
||||
http-socket = :8000
|
||||
plugins = python3
|
||||
processes = 4
|
||||
threads = 2
|
||||
master = true
|
||||
chmod-socket = 660
|
||||
vacuum = true
|
||||
wsgi-file = views.py
|
|
@ -0,0 +1,45 @@
|
|||
"""application entry point"""
|
||||
|
||||
import os
|
||||
|
||||
from flask import Flask, render_template, send_from_directory
|
||||
from src.scheduler import TilefyScheduler
|
||||
from src.template import create_all_tiles, create_single_tile
|
||||
from src.tilefy_redis import TilefyRedis, load_yml
|
||||
|
||||
app = Flask(__name__)
|
||||
|
||||
load_yml()
|
||||
TilefyScheduler().setup_schedule()
|
||||
create_all_tiles()
|
||||
|
||||
|
||||
@app.route("/")
|
||||
def home():
|
||||
"""home page"""
|
||||
host_name = os.environ.get("TILEFY_HOST", "/")
|
||||
config = TilefyRedis().get_message("config")
|
||||
|
||||
tiles = []
|
||||
if config:
|
||||
for tile_slug, tile_config in config["tiles"].items():
|
||||
tile_config["tile_slug"] = tile_slug
|
||||
tiles.append(tile_config)
|
||||
|
||||
return render_template("home.html", tiles=tiles, host_name=host_name)
|
||||
|
||||
|
||||
@app.route("/t/<tile_path>")
|
||||
def get_tile(tile_path):
|
||||
"""return tile as image"""
|
||||
tilename = os.path.splitext(tile_path)[0]
|
||||
tile_config = TilefyRedis().get_message("config", path=f"tiles.{tilename}")
|
||||
recreate = tile_config.get("recreate")
|
||||
if recreate == "on_demand":
|
||||
create_single_tile(tilename, tile_config)
|
||||
|
||||
return send_from_directory(
|
||||
directory="/data/tiles",
|
||||
path=tile_path,
|
||||
cache_timeout=100,
|
||||
)
|
|
@ -0,0 +1,69 @@
|
|||
---
|
||||
|
||||
tiles:
|
||||
tubearchivist-docker:
|
||||
tile_name: Tube Archivist Docker Pulls
|
||||
background_color: "#00202f"
|
||||
font_color: "#97d4c8"
|
||||
width: 1200
|
||||
height: 300
|
||||
logos:
|
||||
- "logos/tube-archivist.png"
|
||||
- "docker.png"
|
||||
url: https://hub.docker.com/v2/repositories/bbilly1/tubearchivist/
|
||||
key_map:
|
||||
- pull_count
|
||||
recreate: "0 * * * *"
|
||||
tubearchivist-github-star:
|
||||
tile_name: Tube Archivist GitHub Stars
|
||||
background_color: "#00202f"
|
||||
font_color: "#97d4c8"
|
||||
width: 1200
|
||||
height: 300
|
||||
logos:
|
||||
- "logos/tube-archivist.png"
|
||||
- "github-star.png"
|
||||
url: https://api.github.com/repos/tubearchivist/tubearchivist
|
||||
key_map:
|
||||
- stargazers_count
|
||||
humanize: false
|
||||
font: ttf-bitstream-vera/VeraMono.ttf
|
||||
recreate: "1 * * * *"
|
||||
tubearchivist-firefox:
|
||||
tile_name: TA Companion Firefox users
|
||||
background_color: "#00202f"
|
||||
font_color: "#97d4c8"
|
||||
width: 1200
|
||||
height: 300
|
||||
logos:
|
||||
- "logos/tube-archivist.png"
|
||||
- "firefox.png"
|
||||
url: https://addons.mozilla.org/api/v5/addons/addon/tubearchivist-companion/
|
||||
key_map:
|
||||
- average_daily_users
|
||||
tubearchivist-chrome:
|
||||
tile_name: TA Companion Chrome users
|
||||
background_color: "#00202f"
|
||||
font_color: "#97d4c8"
|
||||
width: 1200
|
||||
height: 300
|
||||
logos:
|
||||
- "logos/tube-archivist.png"
|
||||
- "google-chrome.png"
|
||||
plugin:
|
||||
name: chrome-extension-users
|
||||
id: jjnkmicfnfojkkgobdfeieblocadmcie
|
||||
tubearchivist-last-action:
|
||||
tile_name: TA last GitHub Action status
|
||||
background_color: "#00202f"
|
||||
font_color: "#97d4c8"
|
||||
width: 1200
|
||||
height: 300
|
||||
logos:
|
||||
- "github-actions.png"
|
||||
url: https://api.github.com/repos/tubearchivist/tubearchivist/actions/runs?branch=master&event=push&per_page=1
|
||||
key_map:
|
||||
- "workflow_runs"
|
||||
- 0
|
||||
- "conclusion"
|
||||
recreate: on_demand
|
|
@ -0,0 +1,115 @@
|
|||
#!/usr/bin/env python
|
||||
""" check requirements.txt for outdated packages """
|
||||
|
||||
import pathlib
|
||||
|
||||
import requests
|
||||
|
||||
|
||||
class Requirements:
|
||||
"""handle requirements.txt"""
|
||||
|
||||
FILE_PATH = "tilefy/requirements.txt"
|
||||
LOCK = "/tmp/tilefy-requirements.lock"
|
||||
|
||||
def __init__(self):
|
||||
self.exists = self.checked_today()
|
||||
self.all_requirements = False
|
||||
self.all_updates = False
|
||||
|
||||
def checked_today(self):
|
||||
"""skip requirements check when lock file exists"""
|
||||
exists = pathlib.Path(self.LOCK).exists()
|
||||
return exists
|
||||
|
||||
def look_for_updates(self):
|
||||
"""look through requirements and check for updates"""
|
||||
self.all_requirements = self.get_dependencies()
|
||||
self.all_updates = self.check_packages()
|
||||
|
||||
def get_dependencies(self):
|
||||
"""read out requirements.txt"""
|
||||
|
||||
all_requirements = []
|
||||
with open(self.FILE_PATH, "r", encoding="utf-8") as f:
|
||||
dependencies = f.readlines()
|
||||
|
||||
for dependency in dependencies:
|
||||
package, version = dependency.split("==")
|
||||
all_requirements.append((package, version.strip()))
|
||||
|
||||
all_requirements.sort(key=lambda x: x[0].lower())
|
||||
|
||||
return all_requirements
|
||||
|
||||
def check_packages(self):
|
||||
"""compare installed with remote version"""
|
||||
|
||||
total = len(self.all_requirements)
|
||||
print(f"checking versions for {total} packages...")
|
||||
|
||||
all_updates = {}
|
||||
|
||||
for dependency in self.all_requirements:
|
||||
package, version_installed = dependency
|
||||
url = f"https://pypi.org/pypi/{package}/json"
|
||||
response = requests.get(url).json()
|
||||
version_remote = response["info"]["version"]
|
||||
homepage = response["info"]["home_page"]
|
||||
if version_remote != version_installed:
|
||||
to_update = {
|
||||
package: {"from": version_installed, "to": version_remote}
|
||||
}
|
||||
all_updates.update(to_update)
|
||||
message = (
|
||||
f"update {package} {version_installed}"
|
||||
+ f"==> {version_remote}\n {homepage}"
|
||||
)
|
||||
print(message)
|
||||
|
||||
if not all_updates:
|
||||
print("no updates found")
|
||||
|
||||
# remember that
|
||||
pathlib.Path(self.LOCK).touch()
|
||||
|
||||
return all_updates
|
||||
|
||||
def apply_updates(self):
|
||||
"""update requirements.txt file with new versions"""
|
||||
|
||||
to_write = []
|
||||
|
||||
for requirement in self.all_requirements:
|
||||
package, old_version = requirement
|
||||
|
||||
if package in self.all_updates.keys():
|
||||
package_version = self.all_updates[package]["to"]
|
||||
else:
|
||||
package_version = old_version
|
||||
|
||||
to_write.append(f"{package}=={package_version}\n")
|
||||
|
||||
with open(self.FILE_PATH, "w", encoding="utf-8") as f:
|
||||
f.writelines(to_write)
|
||||
|
||||
print("requirements.txt updates")
|
||||
|
||||
|
||||
def main():
|
||||
"""main to check for updates"""
|
||||
handler = Requirements()
|
||||
if handler.exists:
|
||||
return
|
||||
|
||||
handler.look_for_updates()
|
||||
if handler.all_updates:
|
||||
input_response = input("\nupdate requirements.txt? [y/n] ")
|
||||
if input_response == "y":
|
||||
handler.apply_updates()
|
||||
else:
|
||||
print("skip update...")
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|