steffo/lihzahrd
steffo/lihzahrd
1
Fork 0
mirror of https://github.com/Steffo99/lihzahrd.git synced 2024-11-24 09:04:22 +00:00
Code Activity

3.1.1: Improve project metadata

Browse source
This commit is contained in:
Steffo 2024-09-04 17:05:01 +02:00
parent 5e18b725a8
commit 5655ae3e74
Signed by: steffo
GPG key ID: 5ADA3868646C3FC0
5 changed files with 341 additions and 718 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
.media/icon-128x128_round.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 6.1 KiB

31
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,31 @@
# Contributing
## Setting up a development environment
To contribute to `lihzahrd`, you'll need to use [Poetry](https://poetry.eustace.io/).
1. Clone the git repo with the command:
```shell
git clone https://github.com/Steffo99/lihzahrd
```
2. Enter the new directory:
```shell
cd lihzahrd
```
3. Install all dependencies and the package:
```shell
poetry install
```
4. Activate the newly created virtual environment:
```shell
$ poetry shell
```
Please note that for compatibility with PyPy, the project needs to target Python 3.6.

948
LICENSE.txt
View file

@ -1,661 +1,287 @@
GNU AFFERO GENERAL PUBLIC LICENSE EUROPEAN UNION PUBLIC LICENCE v. 1.2
Version 3, 19 November 2007 EUPL © the European Union 2007, 2016
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> This European Union Public Licence (the ‘EUPL’) applies to the Work (as defined
Everyone is permitted to copy and distribute verbatim copies below) which is provided under the terms of this Licence. Any use of the Work,
of this license document, but changing it is not allowed. other than as authorised under this Licence is prohibited (to the extent such
use is covered by a right of the copyright holder of the Work).
Preamble
The Work is provided under the terms of this Licence when the Licensor (as
The GNU Affero General Public License is a free, copyleft license for defined below) has placed the following notice immediately following the
software and other kinds of works, specifically designed to ensure copyright notice for the Work:
cooperation with the community in the case of network server software.
Licensed under the EUPL
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast, or has expressed by any other means his willingness to license under the EUPL.
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free 1. Definitions
software for all its users.
In this Licence, the following terms have the following meaning:
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you - ‘The Licence’: this Licence.
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 - ‘The Original Work’: the work or software distributed or communicated by the
want it, that you can change the software or use pieces of it in new Licensor under this Licence, available as Source Code and also as Executable
free programs, and that you know you can do these things. Code as the case may be.
Developers that use our General Public Licenses protect your rights - ‘Derivative Works’: the works or software that could be created by the
with two steps: (1) assert copyright on the software, and (2) offer Licensee, based upon the Original Work or modifications thereof. This Licence
you this License which gives you legal permission to copy, distribute does not define the extent of modification or dependence on the Original Work
and/or modify the software. required in order to classify a work as a Derivative Work; this extent is
determined by copyright law applicable in the country mentioned in Article 15.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they - ‘The Work’: the Original Work or its Derivative Works.
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and - ‘The Source Code’: the human-readable form of the Work which is the most
encouraged by the resulting cooperation. However, in the case of convenient for people to study and modify.
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and - ‘The Executable Code’: any code which has generally been compiled and which is
letting the public access it on a server without ever releasing its meant to be interpreted by a computer as a program.
source code to the public.
- ‘The Licensor’: the natural or legal person that distributes or communicates
The GNU Affero General Public License is designed specifically to the Work under the Licence.
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to - ‘Contributor(s)’: any natural or legal person who modifies the Work under the
provide the source code of the modified version running there to the Licence, or otherwise contributes to the creation of a Derivative Work.
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source - ‘The Licensee’ or ‘You’: any natural or legal person who makes any usage of
code of the modified version. the Work under the terms of the Licence.
An older license, called the Affero General Public License and - ‘Distribution’ or ‘Communication’: any act of selling, giving, lending,
published by Affero, was designed to accomplish similar goals. This is renting, distributing, communicating, transmitting, or otherwise making
a different license, not a version of the Affero GPL, but Affero has available, online or offline, copies of the Work or providing access to its
released a new version of the Affero GPL which permits relicensing under essential functionalities at the disposal of any other natural or legal
this license. person.
The precise terms and conditions for copying, distribution and 2. Scope of the rights granted by the Licence
modification follow.
The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
TERMS AND CONDITIONS sublicensable licence to do the following, for the duration of copyright vested
in the Original Work:
0. Definitions.
- use the Work in any circumstance and for all usage,
"This License" refers to version 3 of the GNU Affero General Public License. - reproduce the Work,
- modify the Work, and make Derivative Works based upon the Work,
"Copyright" also means copyright-like laws that apply to other kinds of - communicate to the public, including the right to make available or display
works, such as semiconductor masks. the Work or copies thereof to the public and perform publicly, as the case may
be, the Work,
"The Program" refers to any copyrightable work licensed under this - distribute the Work or copies thereof,
License. Each licensee is addressed as "you". "Licensees" and - lend and rent the Work or copies thereof,
"recipients" may be individuals or organizations. - sublicense rights in the Work or copies thereof.
To "modify" a work means to copy from or adapt all or part of the work Those rights can be exercised on any media, supports and formats, whether now
in a fashion requiring copyright permission, other than the making of an known or later invented, as far as the applicable law permits so.
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work. In the countries where moral rights apply, the Licensor waives his right to
exercise his moral right to the extent allowed by law in order to make effective
A "covered work" means either the unmodified Program or a work based the licence of the economic rights here above listed.
on the Program.
The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
To "propagate" a work means to do anything with it that, without any patents held by the Licensor, to the extent necessary to make use of the
permission, would make you directly or secondarily liable for rights granted on the Work under this Licence.
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying, 3. Communication of the Source Code
distribution (with or without modification), making available to the
public, and in some countries other activities as well. The Licensor may provide the Work either in its Source Code form, or as
Executable Code. If the Work is provided as Executable Code, the Licensor
To "convey" a work means any kind of propagation that enables other provides in addition a machine-readable copy of the Source Code of the Work
parties to make or receive copies. Mere interaction with a user through along with each copy of the Work that the Licensor distributes or indicates, in
a computer network, with no transfer of a copy, is not conveying. a notice following the copyright notice attached to the Work, a repository where
the Source Code is easily and freely accessible for as long as the Licensor
An interactive user interface displays "Appropriate Legal Notices" continues to distribute or communicate the Work.
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2) 4. Limitations on copyright
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the Nothing in this Licence is intended to deprive the Licensee of the benefits from
work under this License, and how to view a copy of this License. If any exception or limitation to the exclusive rights of the rights owners in the
the interface presents a list of user commands or options, such as a Work, of the exhaustion of those rights or of other applicable limitations
menu, a prominent item in the list meets this criterion. thereto.
1. Source Code. 5. Obligations of the Licensee
The "source code" for a work means the preferred form of the work The grant of the rights mentioned above is subject to some restrictions and
for making modifications to it. "Object code" means any non-source obligations imposed on the Licensee. Those obligations are the following:
form of a work.
Attribution right: The Licensee shall keep intact all copyright, patent or
A "Standard Interface" means an interface that either is an official trademarks notices and all notices that refer to the Licence and to the
standard defined by a recognized standards body, or, in the case of disclaimer of warranties. The Licensee must include a copy of such notices and a
interfaces specified for a particular programming language, one that copy of the Licence with every copy of the Work he/she distributes or
is widely used among developers working in that language. communicates. The Licensee must cause any Derivative Work to carry prominent
notices stating that the Work has been modified and the date of modification.
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 Copyleft clause: If the Licensee distributes or communicates copies of the
packaging a Major Component, but which is not part of that Major Original Works or Derivative Works, this Distribution or Communication will be
Component, and (b) serves only to enable use of the work with that done under the terms of this Licence or of a later version of this Licence
Major Component, or to implement a Standard Interface for which an unless the Original Work is expressly distributed only under this version of the
implementation is available to the public in source code form. A Licence — for example by communicating ‘EUPL v. 1.2 only’. The Licensee
"Major Component", in this context, means a major essential component (becoming Licensor) cannot offer or impose any additional terms or conditions on
(kernel, window system, and so on) of the specific operating system the Work or Derivative Work that alter or restrict the terms of the Licence.
(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. Compatibility clause: If the Licensee Distributes or Communicates Derivative
Works or copies thereof based upon both the Work and another work licensed under
The "Corresponding Source" for a work in object code form means all a Compatible Licence, this Distribution or Communication can be done under the
the source code needed to generate, install, and (for an executable terms of this Compatible Licence. For the sake of this clause, ‘Compatible
work) run the object code and to modify the work, including scripts to Licence’ refers to the licences listed in the appendix attached to this Licence.
control those activities. However, it does not include the work's Should the Licensee's obligations under the Compatible Licence conflict with
System Libraries, or general-purpose tools or generally available free his/her obligations under this Licence, the obligations of the Compatible
programs which are used unmodified in performing those activities but Licence shall prevail.
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for Provision of Source Code: When distributing or communicating copies of the Work,
the work, and the source code for shared libraries and dynamically the Licensee will provide a machine-readable copy of the Source Code or indicate
linked subprograms that the work is specifically designed to require, a repository where this Source will be easily and freely available for as long
such as by intimate data communication or control flow between those as the Licensee continues to distribute or communicate the Work.
subprograms and other parts of the work.
Legal Protection: This Licence does not grant permission to use the trade names,
The Corresponding Source need not include anything that users trademarks, service marks, or names of the Licensor, except as required for
can regenerate automatically from other parts of the Corresponding reasonable and customary use in describing the origin of the Work and
Source. reproducing the content of the copyright notice.
The Corresponding Source for a work in source code form is that 6. Chain of Authorship
same work.
The original Licensor warrants that the copyright in the Original Work granted
2. Basic Permissions. hereunder is owned by him/her or licensed to him/her and that he/she has the
power and authority to grant the Licence.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated Each Contributor warrants that the copyright in the modifications he/she brings
conditions are met. This License explicitly affirms your unlimited to the Work are owned by him/her or licensed to him/her and that he/she has the
permission to run the unmodified Program. The output from running a power and authority to grant the Licence.
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your Each time You accept the Licence, the original Licensor and subsequent
rights of fair use or other equivalent, as provided by copyright law. Contributors grant You a licence to their contributions to the Work, under the
terms of this Licence.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains 7. Disclaimer of Warranty
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you The Work is a work in progress, which is continuously improved by numerous
with facilities for running those works, provided that you comply with Contributors. It is not a finished work and may therefore contain defects or
the terms of this License in conveying all material for which you do ‘bugs’ inherent to this type of development.
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction For the above reason, the Work is provided under the Licence on an ‘as is’ basis
and control, on terms that prohibit them from making any copies of and without warranties of any kind concerning the Work, including without
your copyrighted material outside their relationship with you. limitation merchantability, fitness for a particular purpose, absence of defects
or errors, accuracy, non-infringement of intellectual property rights other than
Conveying under any other circumstances is permitted solely under copyright as stated in Article 6 of this Licence.
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary. This disclaimer of warranty is an essential part of the Licence and a condition
for the grant of any rights to the Work.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
8. Disclaimer of Liability
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article Except in the cases of wilful misconduct or damages directly caused to natural
11 of the WIPO copyright treaty adopted on 20 December 1996, or persons, the Licensor will in no event be liable for any direct or indirect,
similar laws prohibiting or restricting circumvention of such material or moral, damages of any kind, arising out of the Licence or of the use
measures. of the Work, including without limitation, damages for loss of goodwill, work
stoppage, computer failure or malfunction, loss of data or any commercial
When you convey a covered work, you waive any legal power to forbid damage, even if the Licensor has been advised of the possibility of such damage.
circumvention of technological measures to the extent such circumvention However, the Licensor will be liable under statutory product liability laws as
is effected by exercising rights under this License with respect to far such laws apply to the Work.
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 9. Additional agreements
users, your or third parties' legal rights to forbid circumvention of
technological measures. While distributing the Work, You may choose to conclude an additional agreement,
defining obligations or services consistent with this Licence. However, if
4. Conveying Verbatim Copies. accepting obligations, You may act only on your own behalf and on your sole
responsibility, not on behalf of the original Licensor or any other Contributor,
You may convey verbatim copies of the Program's source code as you and only if You agree to indemnify, defend, and hold each Contributor harmless
receive it, in any medium, provided that you conspicuously and for any liability incurred by, or claims asserted against such Contributor by
appropriately publish on each copy an appropriate copyright notice; the fact You have accepted any warranty or additional liability.
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code; 10. Acceptance of the Licence
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program. The provisions of this Licence can be accepted by clicking on an icon ‘I agree’
placed under the bottom of a window displaying the text of this Licence or by
You may charge any price or no price for each copy that you convey, affirming consent in any other similar way, in accordance with the rules of
and you may offer support or warranty protection for a fee. applicable law. Clicking on that icon indicates your clear and irrevocable
acceptance of this Licence and all of its terms and conditions.
5. Conveying Modified Source Versions.
Similarly, you irrevocably accept this Licence and all of its terms and
You may convey a work based on the Program, or the modifications to conditions by exercising any rights granted to You by Article 2 of this Licence,
produce it from the Program, in the form of source code under the such as the use of the Work, the creation by You of a Derivative Work or the
terms of section 4, provided that you also meet all of these conditions: Distribution or Communication by You of the Work or copies thereof.
a) The work must carry prominent notices stating that you modified 11. Information to the public
it, and giving a relevant date.
In case of any Distribution or Communication of the Work by means of electronic
b) The work must carry prominent notices stating that it is communication by You (for example, by offering to download the Work from a
released under this License and any conditions added under section remote location) the distribution channel or media (for example, a website) must
7. This requirement modifies the requirement in section 4 to at least provide to the public the information requested by the applicable law
"keep intact all notices". regarding the Licensor, the Licence and the way it may be accessible, concluded,
stored and reproduced by the Licensee.
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This 12. Termination of the Licence
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts, The Licence and the rights granted hereunder will terminate automatically upon
regardless of how they are packaged. This License gives no any breach by the Licensee of the terms of the Licence.
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it. Such a termination will not terminate the licences of any person who has
received the Work from the Licensee under the Licence, provided such persons
d) If the work has interactive user interfaces, each must display remain in full compliance with the Licence.
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your 13. Miscellaneous
work need not make them do so.
Without prejudice of Article 9 above, the Licence represents the complete
A compilation of a covered work with other separate and independent agreement between the Parties as to the Work.
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, If any provision of the Licence is invalid or unenforceable under applicable
in or on a volume of a storage or distribution medium, is called an law, this will not affect the validity or enforceability of the Licence as a
"aggregate" if the compilation and its resulting copyright are not whole. Such provision will be construed or reformed so as necessary to make it
used to limit the access or legal rights of the compilation's users valid and enforceable.
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other The European Commission may publish other linguistic versions or new versions of
parts of the aggregate. this Licence or updated versions of the Appendix, so far this is required and
reasonable, without reducing the scope of the rights granted by the Licence. New
6. Conveying Non-Source Forms. versions of the Licence will be published with a unique version number.
You may convey a covered work in object code form under the terms All linguistic versions of this Licence, approved by the European Commission,
of sections 4 and 5, provided that you also convey the have identical value. Parties can take advantage of the linguistic version of
machine-readable Corresponding Source under the terms of this License, their choice.
in one of these ways:
14. Jurisdiction
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the Without prejudice to specific agreement between parties,
Corresponding Source fixed on a durable physical medium
customarily used for software interchange. - any litigation resulting from the interpretation of this License, arising
between the European Union institutions, bodies, offices or agencies, as a
b) Convey the object code in, or embodied in, a physical product Licensor, and any Licensee, will be subject to the jurisdiction of the Court
(including a physical distribution medium), accompanied by a of Justice of the European Union, as laid down in article 272 of the Treaty on
written offer, valid for at least three years and valid for as the Functioning of the European Union,
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a - any litigation arising between other parties and resulting from the
copy of the Corresponding Source for all the software in the interpretation of this License, will be subject to the exclusive jurisdiction
product that is covered by this License, on a durable physical of the competent court where the Licensor resides or conducts its primary
medium customarily used for software interchange, for a price no business.
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the 15. Applicable Law
Corresponding Source from a network server at no charge.
Without prejudice to specific agreement between parties,
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This - this Licence shall be governed by the law of the European Union Member State
alternative is allowed only occasionally and noncommercially, and where the Licensor has his seat, resides or has his registered office,
only if you received the object code with such an offer, in accord
with subsection 6b. - this licence shall be governed by Belgian law if the Licensor has no seat,
residence or registered office inside a European Union Member State.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the Appendix
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the ‘Compatible Licences’ according to Article 5 EUPL are:
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source - GNU General Public License (GPL) v. 2, v. 3
may be on a different server (operated by you or a third party) - GNU Affero General Public License (AGPL) v. 3
that supports equivalent copying facilities, provided you maintain - Open Software License (OSL) v. 2.1, v. 3.0
clear directions next to the object code saying where to find the - Eclipse Public License (EPL) v. 1.0
Corresponding Source. Regardless of what server hosts the - CeCILL v. 2.0, v. 2.1
Corresponding Source, you remain obligated to ensure that it is - Mozilla Public Licence (MPL) v. 2
available for as long as needed to satisfy these requirements. - GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
e) Convey the object code using peer-to-peer transmission, provided works other than software
you inform other peers where the object code and Corresponding - European Union Public Licence (EUPL) v. 1.1, v. 1.2
Source of the work are being offered to the general public at no - Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
charge under subsection 6d. Reciprocity (LiLiQ-R+).
A separable portion of the object code, whose source code is excluded The European Commission may update this Appendix to later versions of the above
from the Corresponding Source as a System Library, need not be licences without producing a new version of the EUPL, as long as they provide
included in conveying the object code work. the rights granted in Article 2 of this Licence and protect the covered Source
Code from exclusive appropriation.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family, All other changes or additions to this Appendix require the production of a new
or household purposes, or (2) anything designed or sold for incorporation EUPL version.
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. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
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 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 work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details.
You should have received a copy of the GNU Affero 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 your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
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 AGPL, see
<https://www.gnu.org/licenses/>.

76
README.md
View file

@ -1,27 +1,28 @@
# ![](https://gamepedia.cursecdn.com/terraria_gamepedia/e/ee/Lihzahrd.png?version=b8e7ea78b2f9f27a46e2e70d5684b344) `lihzahrd` [![Available on PyPI](https://img.shields.io/pypi/v/lihzahrd)](https://pypi.org/project/lihzahrd/) <div align="center">
A Terraria 1.4.4.9 world parser in Python. ![](.media/icon-128x128_round.png)
You can use this package to get programmer-friendly data from a Terraria world! # Lihzahrd
Terraria game world parser for Python.
</div>
## Links
[![Available on PyPI](https://img.shields.io/pypi/v/lihzahrd)](https://pypi.org/project/lihzahrd/)
[![Full documentation](https://img.shields.io/website?url=https%3A%2F%2Fgh.steffo.eu%2Flihzahrd%2Fhtml%2F&up_message=passing&down_message=failing&label=docs)](https://gh.steffo.eu/lihzahrd/html/)
## Installation ## Installation
Use your favourite Python package manager to install `lihzahrd`: Lihzahrd can be installed from PyPI like any other public Python package.
- Venv + Pip Using [uv](https://docs.astral.sh/uv/), that means:
```console ```shell
$ source .venv/bin/activate uv add lihzahrd
$ pip install lihzahrd ```
```
- Poetry
```console
$ poetry add lihzahrd
```
- And more!
## Usage ## Usage
@ -36,11 +37,11 @@ It _will_ take a while to process: a small Terraria world contains more than 5 m
Once you have a `World` object, you can use all data present in the save file by accessing [its attributes](http://gh.steffo.eu/lihzahrd/html/world.html). Once you have a `World` object, you can use all data present in the save file by accessing [its attributes](http://gh.steffo.eu/lihzahrd/html/world.html).
> **Warning** > [!Warning]
> >
> Loading maliciously designed Terraria worlds can drain system resources, crash the interpreter, or possibly do more evil things! > Maliciously designed Terraria worlds can drain system resources, crash the interpreter, or possibly do other evil things!
> >
> **Make sure you trust the worlds you are parsing!** > **Make sure you trust worlds before parsing them!**
## Documentation ## Documentation
@ -61,36 +62,6 @@ Time to parse the same large world:
- CPython took 11.45 s. - CPython took 11.45 s.
- Pypy took 3.57 s! - Pypy took 3.57 s!
## Development
To contribute to `lihzahrd`, you need to have [Poetry](https://poetry.eustace.io/) installed on your PC.
After you've installed Poetry, clone the git repo with the command:
```console
$ git clone https://github.com/Steffo99/lihzahrd
```
Then enter the new directory:
```console
$ cd lihzahrd
```
And finally install all dependencies and the package:
```console
$ poetry install
```
This will create a new virtualenv for the development of the library; you can activate it by typing:
```console
$ poetry shell
```
Please note that for compatibility with PyPy, the project needs to target Python 3.6.
### Building docs ### Building docs
You can build the docs by entering the `docs_source` folder and running `make html`, then committing the whole `docs` folder. You can build the docs by entering the `docs_source` folder and running `make html`, then committing the whole `docs` folder.
@ -104,11 +75,6 @@ You can build the docs by entering the `docs_source` folder and running `make ht
- A [JS World Parser](https://github.com/cokolele/terraria-world-parser/) on GitHub. - A [JS World Parser](https://github.com/cokolele/terraria-world-parser/) on GitHub.
- A [Background Guide](https://steamcommunity.com/sharedfiles/filedetails/?id=841032800) on Steam that displays all possible world backgrounds. - A [Background Guide](https://steamcommunity.com/sharedfiles/filedetails/?id=841032800) on Steam that displays all possible world backgrounds.
## License
`lihzahrd` is licensed under the [AGPL 3.0](/LICENSE.txt).
That means you have to publish under the same license the source code of any program you create that uses `lihzahrd`.
## See also ## See also
- [flyingsnake](https://github.com/Steffo99/flyingsnake), a map renderer using this package - [flyingsnake](https://github.com/Steffo99/flyingsnake), a map renderer using this package

4
pyproject.toml
View file

@ -22,7 +22,7 @@ build-backend = "poetry.core.masonry.api"
name = "lihzahrd" name = "lihzahrd"
# The version of the package. # The version of the package.
version = "3.1.0" version = "3.1.1"
# A brief, one-sentence description about your project. # A brief, one-sentence description about your project.
description = "A Terraria world parser in Python" description = "A Terraria world parser in Python"
@ -40,7 +40,7 @@ maintainers = [
# The license of the package. # The license of the package.
# Uses SPDX format: https://spdx.org/licenses/ # Uses SPDX format: https://spdx.org/licenses/
license = "AGPL-3.0-or-later" license = "EUPL-1.2"
# The README file. # The README file.
readme = "README.md" readme = "README.md"