redone the project structure
This commit is contained in:
parent
8d68e815ef
commit
a4f569e2bf
674
LICENSE.txt
Normal file
674
LICENSE.txt
Normal file
@ -0,0 +1,674 @@
|
|||||||
|
GNU GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
Preamble
|
||||||
|
|
||||||
|
The GNU General Public License is a free, copyleft license for
|
||||||
|
software and other kinds of works.
|
||||||
|
|
||||||
|
The licenses for most software and other practical works are designed
|
||||||
|
to take away your freedom to share and change the works. By contrast,
|
||||||
|
the GNU General Public License is intended to guarantee your freedom to
|
||||||
|
share and change all versions of a program--to make sure it remains free
|
||||||
|
software for all its users. We, the Free Software Foundation, use the
|
||||||
|
GNU General Public License for most of our software; it applies also to
|
||||||
|
any other work released this way by its authors. You can apply it to
|
||||||
|
your programs, too.
|
||||||
|
|
||||||
|
When we speak of free software, we are referring to freedom, not
|
||||||
|
price. Our General Public Licenses are designed to make sure that you
|
||||||
|
have the freedom to distribute copies of free software (and charge for
|
||||||
|
them if you wish), that you receive source code or can get it if you
|
||||||
|
want it, that you can change the software or use pieces of it in new
|
||||||
|
free programs, and that you know you can do these things.
|
||||||
|
|
||||||
|
To protect your rights, we need to prevent others from denying you
|
||||||
|
these rights or asking you to surrender the rights. Therefore, you have
|
||||||
|
certain responsibilities if you distribute copies of the software, or if
|
||||||
|
you modify it: responsibilities to respect the freedom of others.
|
||||||
|
|
||||||
|
For example, if you distribute copies of such a program, whether
|
||||||
|
gratis or for a fee, you must pass on to the recipients the same
|
||||||
|
freedoms that you received. You must make sure that they, too, receive
|
||||||
|
or can get the source code. And you must show them these terms so they
|
||||||
|
know their rights.
|
||||||
|
|
||||||
|
Developers that use the GNU GPL protect your rights with two steps:
|
||||||
|
(1) assert copyright on the software, and (2) offer you this License
|
||||||
|
giving you legal permission to copy, distribute and/or modify it.
|
||||||
|
|
||||||
|
For the developers' and authors' protection, the GPL clearly explains
|
||||||
|
that there is no warranty for this free software. For both users' and
|
||||||
|
authors' sake, the GPL requires that modified versions be marked as
|
||||||
|
changed, so that their problems will not be attributed erroneously to
|
||||||
|
authors of previous versions.
|
||||||
|
|
||||||
|
Some devices are designed to deny users access to install or run
|
||||||
|
modified versions of the software inside them, although the manufacturer
|
||||||
|
can do so. This is fundamentally incompatible with the aim of
|
||||||
|
protecting users' freedom to change the software. The systematic
|
||||||
|
pattern of such abuse occurs in the area of products for individuals to
|
||||||
|
use, which is precisely where it is most unacceptable. Therefore, we
|
||||||
|
have designed this version of the GPL to prohibit the practice for those
|
||||||
|
products. If such problems arise substantially in other domains, we
|
||||||
|
stand ready to extend this provision to those domains in future versions
|
||||||
|
of the GPL, as needed to protect the freedom of users.
|
||||||
|
|
||||||
|
Finally, every program is threatened constantly by software patents.
|
||||||
|
States should not allow patents to restrict development and use of
|
||||||
|
software on general-purpose computers, but in those that do, we wish to
|
||||||
|
avoid the special danger that patents applied to a free program could
|
||||||
|
make it effectively proprietary. To prevent this, the GPL assures that
|
||||||
|
patents cannot be used to render the program non-free.
|
||||||
|
|
||||||
|
The precise terms and conditions for copying, distribution and
|
||||||
|
modification follow.
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
0. Definitions.
|
||||||
|
|
||||||
|
"This License" refers to version 3 of the GNU General Public License.
|
||||||
|
|
||||||
|
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||||
|
works, such as semiconductor masks.
|
||||||
|
|
||||||
|
"The Program" refers to any copyrightable work licensed under this
|
||||||
|
License. Each licensee is addressed as "you". "Licensees" and
|
||||||
|
"recipients" may be individuals or organizations.
|
||||||
|
|
||||||
|
To "modify" a work means to copy from or adapt all or part of the work
|
||||||
|
in a fashion requiring copyright permission, other than the making of an
|
||||||
|
exact copy. The resulting work is called a "modified version" of the
|
||||||
|
earlier work or a work "based on" the earlier work.
|
||||||
|
|
||||||
|
A "covered work" means either the unmodified Program or a work based
|
||||||
|
on the Program.
|
||||||
|
|
||||||
|
To "propagate" a work means to do anything with it that, without
|
||||||
|
permission, would make you directly or secondarily liable for
|
||||||
|
infringement under applicable copyright law, except executing it on a
|
||||||
|
computer or modifying a private copy. Propagation includes copying,
|
||||||
|
distribution (with or without modification), making available to the
|
||||||
|
public, and in some countries other activities as well.
|
||||||
|
|
||||||
|
To "convey" a work means any kind of propagation that enables other
|
||||||
|
parties to make or receive copies. Mere interaction with a user through
|
||||||
|
a computer network, with no transfer of a copy, is not conveying.
|
||||||
|
|
||||||
|
An interactive user interface displays "Appropriate Legal Notices"
|
||||||
|
to the extent that it includes a convenient and prominently visible
|
||||||
|
feature that (1) displays an appropriate copyright notice, and (2)
|
||||||
|
tells the user that there is no warranty for the work (except to the
|
||||||
|
extent that warranties are provided), that licensees may convey the
|
||||||
|
work under this License, and how to view a copy of this License. If
|
||||||
|
the interface presents a list of user commands or options, such as a
|
||||||
|
menu, a prominent item in the list meets this criterion.
|
||||||
|
|
||||||
|
1. Source Code.
|
||||||
|
|
||||||
|
The "source code" for a work means the preferred form of the work
|
||||||
|
for making modifications to it. "Object code" means any non-source
|
||||||
|
form of a work.
|
||||||
|
|
||||||
|
A "Standard Interface" means an interface that either is an official
|
||||||
|
standard defined by a recognized standards body, or, in the case of
|
||||||
|
interfaces specified for a particular programming language, one that
|
||||||
|
is widely used among developers working in that language.
|
||||||
|
|
||||||
|
The "System Libraries" of an executable work include anything, other
|
||||||
|
than the work as a whole, that (a) is included in the normal form of
|
||||||
|
packaging a Major Component, but which is not part of that Major
|
||||||
|
Component, and (b) serves only to enable use of the work with that
|
||||||
|
Major Component, or to implement a Standard Interface for which an
|
||||||
|
implementation is available to the public in source code form. A
|
||||||
|
"Major Component", in this context, means a major essential component
|
||||||
|
(kernel, window system, and so on) of the specific operating system
|
||||||
|
(if any) on which the executable work runs, or a compiler used to
|
||||||
|
produce the work, or an object code interpreter used to run it.
|
||||||
|
|
||||||
|
The "Corresponding Source" for a work in object code form means all
|
||||||
|
the source code needed to generate, install, and (for an executable
|
||||||
|
work) run the object code and to modify the work, including scripts to
|
||||||
|
control those activities. However, it does not include the work's
|
||||||
|
System Libraries, or general-purpose tools or generally available free
|
||||||
|
programs which are used unmodified in performing those activities but
|
||||||
|
which are not part of the work. For example, Corresponding Source
|
||||||
|
includes interface definition files associated with source files for
|
||||||
|
the work, and the source code for shared libraries and dynamically
|
||||||
|
linked subprograms that the work is specifically designed to require,
|
||||||
|
such as by intimate data communication or control flow between those
|
||||||
|
subprograms and other parts of the work.
|
||||||
|
|
||||||
|
The Corresponding Source need not include anything that users
|
||||||
|
can regenerate automatically from other parts of the Corresponding
|
||||||
|
Source.
|
||||||
|
|
||||||
|
The Corresponding Source for a work in source code form is that
|
||||||
|
same work.
|
||||||
|
|
||||||
|
2. Basic Permissions.
|
||||||
|
|
||||||
|
All rights granted under this License are granted for the term of
|
||||||
|
copyright on the Program, and are irrevocable provided the stated
|
||||||
|
conditions are met. This License explicitly affirms your unlimited
|
||||||
|
permission to run the unmodified Program. The output from running a
|
||||||
|
covered work is covered by this License only if the output, given its
|
||||||
|
content, constitutes a covered work. This License acknowledges your
|
||||||
|
rights of fair use or other equivalent, as provided by copyright law.
|
||||||
|
|
||||||
|
You may make, run and propagate covered works that you do not
|
||||||
|
convey, without conditions so long as your license otherwise remains
|
||||||
|
in force. You may convey covered works to others for the sole purpose
|
||||||
|
of having them make modifications exclusively for you, or provide you
|
||||||
|
with facilities for running those works, provided that you comply with
|
||||||
|
the terms of this License in conveying all material for which you do
|
||||||
|
not control copyright. Those thus making or running the covered works
|
||||||
|
for you must do so exclusively on your behalf, under your direction
|
||||||
|
and control, on terms that prohibit them from making any copies of
|
||||||
|
your copyrighted material outside their relationship with you.
|
||||||
|
|
||||||
|
Conveying under any other circumstances is permitted solely under
|
||||||
|
the conditions stated below. Sublicensing is not allowed; section 10
|
||||||
|
makes it unnecessary.
|
||||||
|
|
||||||
|
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||||
|
|
||||||
|
No covered work shall be deemed part of an effective technological
|
||||||
|
measure under any applicable law fulfilling obligations under article
|
||||||
|
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||||
|
similar laws prohibiting or restricting circumvention of such
|
||||||
|
measures.
|
||||||
|
|
||||||
|
When you convey a covered work, you waive any legal power to forbid
|
||||||
|
circumvention of technological measures to the extent such circumvention
|
||||||
|
is effected by exercising rights under this License with respect to
|
||||||
|
the covered work, and you disclaim any intention to limit operation or
|
||||||
|
modification of the work as a means of enforcing, against the work's
|
||||||
|
users, your or third parties' legal rights to forbid circumvention of
|
||||||
|
technological measures.
|
||||||
|
|
||||||
|
4. Conveying Verbatim Copies.
|
||||||
|
|
||||||
|
You may convey verbatim copies of the Program's source code as you
|
||||||
|
receive it, in any medium, provided that you conspicuously and
|
||||||
|
appropriately publish on each copy an appropriate copyright notice;
|
||||||
|
keep intact all notices stating that this License and any
|
||||||
|
non-permissive terms added in accord with section 7 apply to the code;
|
||||||
|
keep intact all notices of the absence of any warranty; and give all
|
||||||
|
recipients a copy of this License along with the Program.
|
||||||
|
|
||||||
|
You may charge any price or no price for each copy that you convey,
|
||||||
|
and you may offer support or warranty protection for a fee.
|
||||||
|
|
||||||
|
5. Conveying Modified Source Versions.
|
||||||
|
|
||||||
|
You may convey a work based on the Program, or the modifications to
|
||||||
|
produce it from the Program, in the form of source code under the
|
||||||
|
terms of section 4, provided that you also meet all of these conditions:
|
||||||
|
|
||||||
|
a) The work must carry prominent notices stating that you modified
|
||||||
|
it, and giving a relevant date.
|
||||||
|
|
||||||
|
b) The work must carry prominent notices stating that it is
|
||||||
|
released under this License and any conditions added under section
|
||||||
|
7. This requirement modifies the requirement in section 4 to
|
||||||
|
"keep intact all notices".
|
||||||
|
|
||||||
|
c) You must license the entire work, as a whole, under this
|
||||||
|
License to anyone who comes into possession of a copy. This
|
||||||
|
License will therefore apply, along with any applicable section 7
|
||||||
|
additional terms, to the whole of the work, and all its parts,
|
||||||
|
regardless of how they are packaged. This License gives no
|
||||||
|
permission to license the work in any other way, but it does not
|
||||||
|
invalidate such permission if you have separately received it.
|
||||||
|
|
||||||
|
d) If the work has interactive user interfaces, each must display
|
||||||
|
Appropriate Legal Notices; however, if the Program has interactive
|
||||||
|
interfaces that do not display Appropriate Legal Notices, your
|
||||||
|
work need not make them do so.
|
||||||
|
|
||||||
|
A compilation of a covered work with other separate and independent
|
||||||
|
works, which are not by their nature extensions of the covered work,
|
||||||
|
and which are not combined with it such as to form a larger program,
|
||||||
|
in or on a volume of a storage or distribution medium, is called an
|
||||||
|
"aggregate" if the compilation and its resulting copyright are not
|
||||||
|
used to limit the access or legal rights of the compilation's users
|
||||||
|
beyond what the individual works permit. Inclusion of a covered work
|
||||||
|
in an aggregate does not cause this License to apply to the other
|
||||||
|
parts of the aggregate.
|
||||||
|
|
||||||
|
6. Conveying Non-Source Forms.
|
||||||
|
|
||||||
|
You may convey a covered work in object code form under the terms
|
||||||
|
of sections 4 and 5, provided that you also convey the
|
||||||
|
machine-readable Corresponding Source under the terms of this License,
|
||||||
|
in one of these ways:
|
||||||
|
|
||||||
|
a) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by the
|
||||||
|
Corresponding Source fixed on a durable physical medium
|
||||||
|
customarily used for software interchange.
|
||||||
|
|
||||||
|
b) Convey the object code in, or embodied in, a physical product
|
||||||
|
(including a physical distribution medium), accompanied by a
|
||||||
|
written offer, valid for at least three years and valid for as
|
||||||
|
long as you offer spare parts or customer support for that product
|
||||||
|
model, to give anyone who possesses the object code either (1) a
|
||||||
|
copy of the Corresponding Source for all the software in the
|
||||||
|
product that is covered by this License, on a durable physical
|
||||||
|
medium customarily used for software interchange, for a price no
|
||||||
|
more than your reasonable cost of physically performing this
|
||||||
|
conveying of source, or (2) access to copy the
|
||||||
|
Corresponding Source from a network server at no charge.
|
||||||
|
|
||||||
|
c) Convey individual copies of the object code with a copy of the
|
||||||
|
written offer to provide the Corresponding Source. This
|
||||||
|
alternative is allowed only occasionally and noncommercially, and
|
||||||
|
only if you received the object code with such an offer, in accord
|
||||||
|
with subsection 6b.
|
||||||
|
|
||||||
|
d) Convey the object code by offering access from a designated
|
||||||
|
place (gratis or for a charge), and offer equivalent access to the
|
||||||
|
Corresponding Source in the same way through the same place at no
|
||||||
|
further charge. You need not require recipients to copy the
|
||||||
|
Corresponding Source along with the object code. If the place to
|
||||||
|
copy the object code is a network server, the Corresponding Source
|
||||||
|
may be on a different server (operated by you or a third party)
|
||||||
|
that supports equivalent copying facilities, provided you maintain
|
||||||
|
clear directions next to the object code saying where to find the
|
||||||
|
Corresponding Source. Regardless of what server hosts the
|
||||||
|
Corresponding Source, you remain obligated to ensure that it is
|
||||||
|
available for as long as needed to satisfy these requirements.
|
||||||
|
|
||||||
|
e) Convey the object code using peer-to-peer transmission, provided
|
||||||
|
you inform other peers where the object code and Corresponding
|
||||||
|
Source of the work are being offered to the general public at no
|
||||||
|
charge under subsection 6d.
|
||||||
|
|
||||||
|
A separable portion of the object code, whose source code is excluded
|
||||||
|
from the Corresponding Source as a System Library, need not be
|
||||||
|
included in conveying the object code work.
|
||||||
|
|
||||||
|
A "User Product" is either (1) a "consumer product", which means any
|
||||||
|
tangible personal property which is normally used for personal, family,
|
||||||
|
or household purposes, or (2) anything designed or sold for incorporation
|
||||||
|
into a dwelling. In determining whether a product is a consumer product,
|
||||||
|
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||||
|
product received by a particular user, "normally used" refers to a
|
||||||
|
typical or common use of that class of product, regardless of the status
|
||||||
|
of the particular user or of the way in which the particular user
|
||||||
|
actually uses, or expects or is expected to use, the product. A product
|
||||||
|
is a consumer product regardless of whether the product has substantial
|
||||||
|
commercial, industrial or non-consumer uses, unless such uses represent
|
||||||
|
the only significant mode of use of the product.
|
||||||
|
|
||||||
|
"Installation Information" for a User Product means any methods,
|
||||||
|
procedures, authorization keys, or other information required to install
|
||||||
|
and execute modified versions of a covered work in that User Product from
|
||||||
|
a modified version of its Corresponding Source. The information must
|
||||||
|
suffice to ensure that the continued functioning of the modified object
|
||||||
|
code is in no case prevented or interfered with solely because
|
||||||
|
modification has been made.
|
||||||
|
|
||||||
|
If you convey an object code work under this section in, or with, or
|
||||||
|
specifically for use in, a User Product, and the conveying occurs as
|
||||||
|
part of a transaction in which the right of possession and use of the
|
||||||
|
User Product is transferred to the recipient in perpetuity or for a
|
||||||
|
fixed term (regardless of how the transaction is characterized), the
|
||||||
|
Corresponding Source conveyed under this section must be accompanied
|
||||||
|
by the Installation Information. But this requirement does not apply
|
||||||
|
if neither you nor any third party retains the ability to install
|
||||||
|
modified object code on the User Product (for example, the work has
|
||||||
|
been installed in ROM).
|
||||||
|
|
||||||
|
The requirement to provide Installation Information does not include a
|
||||||
|
requirement to continue to provide support service, warranty, or updates
|
||||||
|
for a work that has been modified or installed by the recipient, or for
|
||||||
|
the User Product in which it has been modified or installed. Access to a
|
||||||
|
network may be denied when the modification itself materially and
|
||||||
|
adversely affects the operation of the network or violates the rules and
|
||||||
|
protocols for communication across the network.
|
||||||
|
|
||||||
|
Corresponding Source conveyed, and Installation Information provided,
|
||||||
|
in accord with this section must be in a format that is publicly
|
||||||
|
documented (and with an implementation available to the public in
|
||||||
|
source code form), and must require no special password or key for
|
||||||
|
unpacking, reading or copying.
|
||||||
|
|
||||||
|
7. Additional Terms.
|
||||||
|
|
||||||
|
"Additional permissions" are terms that supplement the terms of this
|
||||||
|
License by making exceptions from one or more of its conditions.
|
||||||
|
Additional permissions that are applicable to the entire Program shall
|
||||||
|
be treated as though they were included in this License, to the extent
|
||||||
|
that they are valid under applicable law. If additional permissions
|
||||||
|
apply only to part of the Program, that part may be used separately
|
||||||
|
under those permissions, but the entire Program remains governed by
|
||||||
|
this License without regard to the additional permissions.
|
||||||
|
|
||||||
|
When you convey a copy of a covered work, you may at your option
|
||||||
|
remove any additional permissions from that copy, or from any part of
|
||||||
|
it. (Additional permissions may be written to require their own
|
||||||
|
removal in certain cases when you modify the work.) You may place
|
||||||
|
additional permissions on material, added by you to a covered work,
|
||||||
|
for which you have or can give appropriate copyright permission.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, for material you
|
||||||
|
add to a covered work, you may (if authorized by the copyright holders of
|
||||||
|
that material) supplement the terms of this License with terms:
|
||||||
|
|
||||||
|
a) Disclaiming warranty or limiting liability differently from the
|
||||||
|
terms of sections 15 and 16 of this License; or
|
||||||
|
|
||||||
|
b) Requiring preservation of specified reasonable legal notices or
|
||||||
|
author attributions in that material or in the Appropriate Legal
|
||||||
|
Notices displayed by works containing it; or
|
||||||
|
|
||||||
|
c) Prohibiting misrepresentation of the origin of that material, or
|
||||||
|
requiring that modified versions of such material be marked in
|
||||||
|
reasonable ways as different from the original version; or
|
||||||
|
|
||||||
|
d) Limiting the use for publicity purposes of names of licensors or
|
||||||
|
authors of the material; or
|
||||||
|
|
||||||
|
e) Declining to grant rights under trademark law for use of some
|
||||||
|
trade names, trademarks, or service marks; or
|
||||||
|
|
||||||
|
f) Requiring indemnification of licensors and authors of that
|
||||||
|
material by anyone who conveys the material (or modified versions of
|
||||||
|
it) with contractual assumptions of liability to the recipient, for
|
||||||
|
any liability that these contractual assumptions directly impose on
|
||||||
|
those licensors and authors.
|
||||||
|
|
||||||
|
All other non-permissive additional terms are considered "further
|
||||||
|
restrictions" within the meaning of section 10. If the Program as you
|
||||||
|
received it, or any part of it, contains a notice stating that it is
|
||||||
|
governed by this License along with a term that is a further
|
||||||
|
restriction, you may remove that term. If a license document contains
|
||||||
|
a further restriction but permits relicensing or conveying under this
|
||||||
|
License, you may add to a covered work material governed by the terms
|
||||||
|
of that license document, provided that the further restriction does
|
||||||
|
not survive such relicensing or conveying.
|
||||||
|
|
||||||
|
If you add terms to a covered work in accord with this section, you
|
||||||
|
must place, in the relevant source files, a statement of the
|
||||||
|
additional terms that apply to those files, or a notice indicating
|
||||||
|
where to find the applicable terms.
|
||||||
|
|
||||||
|
Additional terms, permissive or non-permissive, may be stated in the
|
||||||
|
form of a separately written license, or stated as exceptions;
|
||||||
|
the above requirements apply either way.
|
||||||
|
|
||||||
|
8. Termination.
|
||||||
|
|
||||||
|
You may not propagate or modify a covered work except as expressly
|
||||||
|
provided under this License. Any attempt otherwise to propagate or
|
||||||
|
modify it is void, and will automatically terminate your rights under
|
||||||
|
this License (including any patent licenses granted under the third
|
||||||
|
paragraph of section 11).
|
||||||
|
|
||||||
|
However, if you cease all violation of this License, then your
|
||||||
|
license from a particular copyright holder is reinstated (a)
|
||||||
|
provisionally, unless and until the copyright holder explicitly and
|
||||||
|
finally terminates your license, and (b) permanently, if the copyright
|
||||||
|
holder fails to notify you of the violation by some reasonable means
|
||||||
|
prior to 60 days after the cessation.
|
||||||
|
|
||||||
|
Moreover, your license from a particular copyright holder is
|
||||||
|
reinstated permanently if the copyright holder notifies you of the
|
||||||
|
violation by some reasonable means, this is the first time you have
|
||||||
|
received notice of violation of this License (for any work) from that
|
||||||
|
copyright holder, and you cure the violation prior to 30 days after
|
||||||
|
your receipt of the notice.
|
||||||
|
|
||||||
|
Termination of your rights under this section does not terminate the
|
||||||
|
licenses of parties who have received copies or rights from you under
|
||||||
|
this License. If your rights have been terminated and not permanently
|
||||||
|
reinstated, you do not qualify to receive new licenses for the same
|
||||||
|
material under section 10.
|
||||||
|
|
||||||
|
9. Acceptance Not Required for Having Copies.
|
||||||
|
|
||||||
|
You are not required to accept this License in order to receive or
|
||||||
|
run a copy of the Program. Ancillary propagation of a covered work
|
||||||
|
occurring solely as a consequence of using peer-to-peer transmission
|
||||||
|
to receive a copy likewise does not require acceptance. However,
|
||||||
|
nothing other than this License grants you permission to propagate or
|
||||||
|
modify any covered work. These actions infringe copyright if you do
|
||||||
|
not accept this License. Therefore, by modifying or propagating a
|
||||||
|
covered work, you indicate your acceptance of this License to do so.
|
||||||
|
|
||||||
|
10. Automatic Licensing of Downstream Recipients.
|
||||||
|
|
||||||
|
Each time you convey a covered work, the recipient automatically
|
||||||
|
receives a license from the original licensors, to run, modify and
|
||||||
|
propagate that work, subject to this License. You are not responsible
|
||||||
|
for enforcing compliance by third parties with this License.
|
||||||
|
|
||||||
|
An "entity transaction" is a transaction transferring control of an
|
||||||
|
organization, or substantially all assets of one, or subdividing an
|
||||||
|
organization, or merging organizations. If propagation of a covered
|
||||||
|
work results from an entity transaction, each party to that
|
||||||
|
transaction who receives a copy of the work also receives whatever
|
||||||
|
licenses to the work the party's predecessor in interest had or could
|
||||||
|
give under the previous paragraph, plus a right to possession of the
|
||||||
|
Corresponding Source of the work from the predecessor in interest, if
|
||||||
|
the predecessor has it or can get it with reasonable efforts.
|
||||||
|
|
||||||
|
You may not impose any further restrictions on the exercise of the
|
||||||
|
rights granted or affirmed under this License. For example, you may
|
||||||
|
not impose a license fee, royalty, or other charge for exercise of
|
||||||
|
rights granted under this License, and you may not initiate litigation
|
||||||
|
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||||
|
any patent claim is infringed by making, using, selling, offering for
|
||||||
|
sale, or importing the Program or any portion of it.
|
||||||
|
|
||||||
|
11. Patents.
|
||||||
|
|
||||||
|
A "contributor" is a copyright holder who authorizes use under this
|
||||||
|
License of the Program or a work on which the Program is based. The
|
||||||
|
work thus licensed is called the contributor's "contributor version".
|
||||||
|
|
||||||
|
A contributor's "essential patent claims" are all patent claims
|
||||||
|
owned or controlled by the contributor, whether already acquired or
|
||||||
|
hereafter acquired, that would be infringed by some manner, permitted
|
||||||
|
by this License, of making, using, or selling its contributor version,
|
||||||
|
but do not include claims that would be infringed only as a
|
||||||
|
consequence of further modification of the contributor version. For
|
||||||
|
purposes of this definition, "control" includes the right to grant
|
||||||
|
patent sublicenses in a manner consistent with the requirements of
|
||||||
|
this License.
|
||||||
|
|
||||||
|
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||||
|
patent license under the contributor's essential patent claims, to
|
||||||
|
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||||
|
propagate the contents of its contributor version.
|
||||||
|
|
||||||
|
In the following three paragraphs, a "patent license" is any express
|
||||||
|
agreement or commitment, however denominated, not to enforce a patent
|
||||||
|
(such as an express permission to practice a patent or covenant not to
|
||||||
|
sue for patent infringement). To "grant" such a patent license to a
|
||||||
|
party means to make such an agreement or commitment not to enforce a
|
||||||
|
patent against the party.
|
||||||
|
|
||||||
|
If you convey a covered work, knowingly relying on a patent license,
|
||||||
|
and the Corresponding Source of the work is not available for anyone
|
||||||
|
to copy, free of charge and under the terms of this License, through a
|
||||||
|
publicly available network server or other readily accessible means,
|
||||||
|
then you must either (1) cause the Corresponding Source to be so
|
||||||
|
available, or (2) arrange to deprive yourself of the benefit of the
|
||||||
|
patent license for this particular work, or (3) arrange, in a manner
|
||||||
|
consistent with the requirements of this License, to extend the patent
|
||||||
|
license to downstream recipients. "Knowingly relying" means you have
|
||||||
|
actual knowledge that, but for the patent license, your conveying the
|
||||||
|
covered work in a country, or your recipient's use of the covered work
|
||||||
|
in a country, would infringe one or more identifiable patents in that
|
||||||
|
country that you have reason to believe are valid.
|
||||||
|
|
||||||
|
If, pursuant to or in connection with a single transaction or
|
||||||
|
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||||
|
covered work, and grant a patent license to some of the parties
|
||||||
|
receiving the covered work authorizing them to use, propagate, modify
|
||||||
|
or convey a specific copy of the covered work, then the patent license
|
||||||
|
you grant is automatically extended to all recipients of the covered
|
||||||
|
work and works based on it.
|
||||||
|
|
||||||
|
A patent license is "discriminatory" if it does not include within
|
||||||
|
the scope of its coverage, prohibits the exercise of, or is
|
||||||
|
conditioned on the non-exercise of one or more of the rights that are
|
||||||
|
specifically granted under this License. You may not convey a covered
|
||||||
|
work if you are a party to an arrangement with a third party that is
|
||||||
|
in the business of distributing software, under which you make payment
|
||||||
|
to the third party based on the extent of your activity of conveying
|
||||||
|
the work, and under which the third party grants, to any of the
|
||||||
|
parties who would receive the covered work from you, a discriminatory
|
||||||
|
patent license (a) in connection with copies of the covered work
|
||||||
|
conveyed by you (or copies made from those copies), or (b) primarily
|
||||||
|
for and in connection with specific products or compilations that
|
||||||
|
contain the covered work, unless you entered into that arrangement,
|
||||||
|
or that patent license was granted, prior to 28 March 2007.
|
||||||
|
|
||||||
|
Nothing in this License shall be construed as excluding or limiting
|
||||||
|
any implied license or other defenses to infringement that may
|
||||||
|
otherwise be available to you under applicable patent law.
|
||||||
|
|
||||||
|
12. No Surrender of Others' Freedom.
|
||||||
|
|
||||||
|
If conditions are imposed on you (whether by court order, agreement or
|
||||||
|
otherwise) that contradict the conditions of this License, they do not
|
||||||
|
excuse you from the conditions of this License. If you cannot convey a
|
||||||
|
covered work so as to satisfy simultaneously your obligations under this
|
||||||
|
License and any other pertinent obligations, then as a consequence you may
|
||||||
|
not convey it at all. For example, if you agree to terms that obligate you
|
||||||
|
to collect a royalty for further conveying from those to whom you convey
|
||||||
|
the Program, the only way you could satisfy both those terms and this
|
||||||
|
License would be to refrain entirely from conveying the Program.
|
||||||
|
|
||||||
|
13. Use with the GNU Affero General Public License.
|
||||||
|
|
||||||
|
Notwithstanding any other provision of this License, you have
|
||||||
|
permission to link or combine any covered work with a work licensed
|
||||||
|
under version 3 of the GNU Affero General Public License into a single
|
||||||
|
combined work, and to convey the resulting work. The terms of this
|
||||||
|
License will continue to apply to the part which is the covered work,
|
||||||
|
but the special requirements of the GNU Affero General Public License,
|
||||||
|
section 13, concerning interaction through a network will apply to the
|
||||||
|
combination as such.
|
||||||
|
|
||||||
|
14. Revised Versions of this License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions of
|
||||||
|
the GNU General Public License from time to time. Such new versions will
|
||||||
|
be similar in spirit to the present version, but may differ in detail to
|
||||||
|
address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Program specifies that a certain numbered version of the GNU General
|
||||||
|
Public License "or any later version" applies to it, you have the
|
||||||
|
option of following the terms and conditions either of that numbered
|
||||||
|
version or of any later version published by the Free Software
|
||||||
|
Foundation. If the Program does not specify a version number of the
|
||||||
|
GNU General Public License, you may choose any version ever published
|
||||||
|
by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Program specifies that a proxy can decide which future
|
||||||
|
versions of the GNU General Public License can be used, that proxy's
|
||||||
|
public statement of acceptance of a version permanently authorizes you
|
||||||
|
to choose that version for the Program.
|
||||||
|
|
||||||
|
Later license versions may give you additional or different
|
||||||
|
permissions. However, no additional obligations are imposed on any
|
||||||
|
author or copyright holder as a result of your choosing to follow a
|
||||||
|
later version.
|
||||||
|
|
||||||
|
15. Disclaimer of Warranty.
|
||||||
|
|
||||||
|
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||||
|
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||||
|
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||||
|
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||||
|
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||||
|
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||||
|
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||||
|
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||||
|
|
||||||
|
16. Limitation of Liability.
|
||||||
|
|
||||||
|
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||||
|
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||||
|
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||||
|
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||||
|
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||||
|
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||||
|
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||||
|
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||||
|
SUCH DAMAGES.
|
||||||
|
|
||||||
|
17. Interpretation of Sections 15 and 16.
|
||||||
|
|
||||||
|
If the disclaimer of warranty and limitation of liability provided
|
||||||
|
above cannot be given local legal effect according to their terms,
|
||||||
|
reviewing courts shall apply local law that most closely approximates
|
||||||
|
an absolute waiver of all civil liability in connection with the
|
||||||
|
Program, unless a warranty or assumption of liability accompanies a
|
||||||
|
copy of the Program in return for a fee.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
How to Apply These Terms to Your New Programs
|
||||||
|
|
||||||
|
If you develop a new program, and you want it to be of the greatest
|
||||||
|
possible use to the public, the best way to achieve this is to make it
|
||||||
|
free software which everyone can redistribute and change under these terms.
|
||||||
|
|
||||||
|
To do so, attach the following notices to the program. It is safest
|
||||||
|
to attach them to the start of each source file to most effectively
|
||||||
|
state the exclusion of warranty; and each file should have at least
|
||||||
|
the "copyright" line and a pointer to where the full notice is found.
|
||||||
|
|
||||||
|
<one line to give the program's name and a brief idea of what it does.>
|
||||||
|
Copyright (C) <year> <name of author>
|
||||||
|
|
||||||
|
This program is free software: you can redistribute it and/or modify
|
||||||
|
it under the terms of the GNU General Public License as published by
|
||||||
|
the Free Software Foundation, either version 3 of the License, or
|
||||||
|
(at your option) any later version.
|
||||||
|
|
||||||
|
This program is distributed in the hope that it will be useful,
|
||||||
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||||
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||||
|
GNU General Public License for more details.
|
||||||
|
|
||||||
|
You should have received a copy of the GNU General Public License
|
||||||
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
Also add information on how to contact you by electronic and paper mail.
|
||||||
|
|
||||||
|
If the program does terminal interaction, make it output a short
|
||||||
|
notice like this when it starts in an interactive mode:
|
||||||
|
|
||||||
|
<program> Copyright (C) <year> <name of author>
|
||||||
|
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||||
|
This is free software, and you are welcome to redistribute it
|
||||||
|
under certain conditions; type `show c' for details.
|
||||||
|
|
||||||
|
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||||
|
parts of the General Public License. Of course, your program's commands
|
||||||
|
might be different; for a GUI interface, you would use an "about box".
|
||||||
|
|
||||||
|
You should also get your employer (if you work as a programmer) or school,
|
||||||
|
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||||
|
For more information on this, and how to apply and follow the GNU GPL, see
|
||||||
|
<https://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
The GNU General Public License does not permit incorporating your program
|
||||||
|
into proprietary programs. If your program is a subroutine library, you
|
||||||
|
may consider it more useful to permit linking proprietary applications with
|
||||||
|
the library. If this is what you want to do, use the GNU Lesser General
|
||||||
|
Public License instead of this License. But first, please read
|
||||||
|
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
1
MANIFEST.in
Normal file
1
MANIFEST.in
Normal file
@ -0,0 +1 @@
|
|||||||
|
recursive-include src/resources *
|
1
archive/compile.bat
Normal file
1
archive/compile.bat
Normal file
@ -0,0 +1 @@
|
|||||||
|
pyinstaller --add-data ./jarvis/db/create_empty_database.sql;jarvis/db ./start.py
|
47
archive/todo_ideas_google.txt
Normal file
47
archive/todo_ideas_google.txt
Normal file
@ -0,0 +1,47 @@
|
|||||||
|
Ok Google souviens-toi que j’ai mis les clés [ou n’importe quel objet] à l’entrée [ou n’importe quel autre endroit]
|
||||||
|
Ok Google, où sont mes clés ?
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Ok Google, où se trouve mon smartphone / iPhone ?
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Ok Google, rappelle-moi de rappeler ma mère à 18 heures
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Ok Google, comment dit-on merci en Chinois mandarin ?
|
||||||
|
Ok Google, traduis “je t’aime” en japonais
|
||||||
|
|
||||||
|
|
||||||
|
Ok Google, appairage Bluetooth
|
||||||
|
Ok Google, déconnecte le Bluetooth
|
||||||
|
|
||||||
|
|
||||||
|
Ok Google, mets le minuteur sur 5 minutes
|
||||||
|
Ok Google, combien de temps reste-t-il sur le minuteur ?
|
||||||
|
Ok Google, arrête/annule le minuteur
|
||||||
|
Ok Google, stop (lorsque le minuteur sonne)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Ok Google, mets une alarme à [heure]
|
||||||
|
Ok Google, annule l’alarme
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Ok Google, quelle est la définition de [mot]
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Ok Google, raconte-moi quelque chose d’intéressant
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Ok Google, parle à Akinator
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
Ok Google, raconte-moi une histoire
|
||||||
|
|
31
run.py
Normal file
31
run.py
Normal file
@ -0,0 +1,31 @@
|
|||||||
|
import logging
|
||||||
|
import pathlib
|
||||||
|
|
||||||
|
# import lingua_franca
|
||||||
|
|
||||||
|
from src import api
|
||||||
|
from src.database import db_utils
|
||||||
|
from src.utils import faster_whisper_utils
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
logging.getLogger().setLevel(logging.INFO)
|
||||||
|
|
||||||
|
# Create the database
|
||||||
|
db_utils.create_database()
|
||||||
|
|
||||||
|
# Load lingua franca in the memory
|
||||||
|
# lingua_franca.load_language(lang="fr")
|
||||||
|
|
||||||
|
# Register each skills
|
||||||
|
# CocktailSkill().register()
|
||||||
|
|
||||||
|
# Load the skills
|
||||||
|
# intent_manager.load_all_skills()
|
||||||
|
|
||||||
|
# Load the STT (whisper) model
|
||||||
|
# whisper_utils.load_model()
|
||||||
|
faster_whisper_utils.load_model()
|
||||||
|
|
||||||
|
# Start the api endpoint
|
||||||
|
api.start_api()
|
184
setup.py
Normal file
184
setup.py
Normal file
@ -0,0 +1,184 @@
|
|||||||
|
# Always prefer setuptools over distutils
|
||||||
|
from setuptools import setup, find_packages
|
||||||
|
import pathlib
|
||||||
|
|
||||||
|
here = pathlib.Path(__file__).parent.resolve()
|
||||||
|
|
||||||
|
# Get the long description from the README file
|
||||||
|
long_description = (here / "README.md").read_text(encoding="utf-8")
|
||||||
|
|
||||||
|
# Arguments marked as "Required" below must be included for upload to PyPI.
|
||||||
|
# Fields marked as "Optional" may be commented out.
|
||||||
|
|
||||||
|
setup(
|
||||||
|
# This is the name of your project. The first time you publish this
|
||||||
|
# package, this name will be registered for you. It will determine how
|
||||||
|
# users can install this project, e.g.:
|
||||||
|
#
|
||||||
|
# $ pip install sampleproject
|
||||||
|
#
|
||||||
|
# And where it will live on PyPI: https://pypi.org/project/sampleproject/
|
||||||
|
#
|
||||||
|
# There are some restrictions on what makes a valid project name
|
||||||
|
# specification here:
|
||||||
|
# https://packaging.python.org/specifications/core-metadata/#name
|
||||||
|
name="jarvis-server", # Required
|
||||||
|
|
||||||
|
# Versions should comply with PEP 440:
|
||||||
|
# https://www.python.org/dev/peps/pep-0440/
|
||||||
|
#
|
||||||
|
# For a discussion on single-sourcing the version across setup.py and the
|
||||||
|
# project code, see
|
||||||
|
# https://packaging.python.org/guides/single-sourcing-package-version/
|
||||||
|
version="1.0.0", # Required
|
||||||
|
|
||||||
|
# This is a one-line description or tagline of what your project does. This
|
||||||
|
# corresponds to the "Summary" metadata field:
|
||||||
|
# https://packaging.python.org/specifications/core-metadata/#summary
|
||||||
|
description="A simple server for running Jarvis", # Optional
|
||||||
|
|
||||||
|
# This is an optional longer description of your project that represents
|
||||||
|
# the body of text which users will see when they visit PyPI.
|
||||||
|
#
|
||||||
|
# Often, this is the same as your README, so you can just read it in from
|
||||||
|
# that file directly (as we have already done above)
|
||||||
|
#
|
||||||
|
# This field corresponds to the "Description" metadata field:
|
||||||
|
# https://packaging.python.org/specifications/core-metadata/#description-optional
|
||||||
|
long_description=long_description, # Optional
|
||||||
|
|
||||||
|
# Denotes that our long_description is in Markdown; valid values are
|
||||||
|
# text/plain, text/x-rst, and text/markdown
|
||||||
|
#
|
||||||
|
# Optional if long_description is written in reStructuredText (rst) but
|
||||||
|
# required for plain-text or Markdown; if unspecified, "applications should
|
||||||
|
# attempt to render [the long_description] as text/x-rst; charset=UTF-8 and
|
||||||
|
# fall back to text/plain if it is not valid rst" (see link below)
|
||||||
|
#
|
||||||
|
# This field corresponds to the "Description-Content-Type" metadata field:
|
||||||
|
# https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
|
||||||
|
long_description_content_type="text/markdown", # Optional (see note above)
|
||||||
|
|
||||||
|
# This should be a valid link to your project's main homepage.
|
||||||
|
#
|
||||||
|
# This field corresponds to the "Home-Page" metadata field:
|
||||||
|
# https://packaging.python.org/specifications/core-metadata/#home-page-optional
|
||||||
|
url="https://github.com/pypa/jarvis-server", # Optional
|
||||||
|
|
||||||
|
# This should be your name or the name of the organization which owns the
|
||||||
|
# project.
|
||||||
|
author="Mathieu Broillet", # Optional
|
||||||
|
|
||||||
|
# This should be a valid email address corresponding to the author listed
|
||||||
|
# above.
|
||||||
|
author_email="mathieu@example.com", # Optional
|
||||||
|
|
||||||
|
# Classifiers help users find your project by categorizing it.
|
||||||
|
#
|
||||||
|
# For a list of valid classifiers, see https://pypi.org/classifiers/
|
||||||
|
classifiers=[ # Optional
|
||||||
|
# How mature is this project? Common values are
|
||||||
|
# 3 - Alpha
|
||||||
|
# 4 - Beta
|
||||||
|
# 5 - Production/Stable
|
||||||
|
"Development Status :: 3 - Alpha",
|
||||||
|
|
||||||
|
# Indicate who your project is intended for
|
||||||
|
"Intended Audience :: Developers",
|
||||||
|
"Topic :: Software Development :: Build Tools",
|
||||||
|
|
||||||
|
# Pick your license as you wish
|
||||||
|
"License :: OSI Approved :: MIT License",
|
||||||
|
|
||||||
|
# Specify the Python versions you support here. In particular, ensure
|
||||||
|
# that you indicate you support Python 3. These classifiers are *not*
|
||||||
|
# checked by 'pip install'. See instead 'python_requires' below.
|
||||||
|
"Programming Language :: Python :: 3",
|
||||||
|
"Programming Language :: Python :: 3.7",
|
||||||
|
"Programming Language :: Python :: 3.8",
|
||||||
|
"Programming Language :: Python :: 3.9",
|
||||||
|
"Programming Language :: Python :: 3.10",
|
||||||
|
"Programming Language :: Python :: 3 :: Only",
|
||||||
|
],
|
||||||
|
|
||||||
|
# This field adds keywords for your project which will appear on the
|
||||||
|
# project page. What does your project relate to?
|
||||||
|
#
|
||||||
|
# Note that this is a list of additional keywords, separated
|
||||||
|
# by commas, to be used to assist searching for the distribution in a
|
||||||
|
# larger catalog.
|
||||||
|
keywords="jarvis, whisper, ai, stt, tts, chatgpt, homeassistant", # Optional
|
||||||
|
|
||||||
|
# When your source code is in a subdirectory under the project root, e.g.
|
||||||
|
# `src/`, it is necessary to specify the `package_dir` argument.
|
||||||
|
package_dir={"": "src"}, # Optional
|
||||||
|
|
||||||
|
# You can just specify package directories manually here if your project is
|
||||||
|
# simple. Or you can use find_packages().
|
||||||
|
#
|
||||||
|
# Alternatively, if you just want to distribute a single Python file, use
|
||||||
|
# the `py_modules` argument instead as follows, which will expect a file
|
||||||
|
# called `my_module.py` to exist:
|
||||||
|
#
|
||||||
|
# py_modules=["my_module"],
|
||||||
|
#
|
||||||
|
packages=find_packages(where="src"), # Required
|
||||||
|
|
||||||
|
# Specify which Python versions you support. In contrast to the
|
||||||
|
# 'Programming Language' classifiers above, 'pip install' will check this
|
||||||
|
# and refuse to install the project if the version does not match. See
|
||||||
|
# https://packaging.python.org/guides/distributing-packages-using-setuptools/#python-requires
|
||||||
|
python_requires=">=3.7, <4",
|
||||||
|
|
||||||
|
# This field lists other packages that your project depends on to run.
|
||||||
|
# Any package you put here will be installed by pip when your project is
|
||||||
|
# installed, so they must be valid existing projects.
|
||||||
|
#
|
||||||
|
# For an analysis of "install_requires" vs pip's requirements files see:
|
||||||
|
# https://packaging.python.org/discussions/install-requires-vs-requirements/
|
||||||
|
install_requires=["peppercorn"], # Optional
|
||||||
|
|
||||||
|
# List additional groups of dependencies here (e.g. development
|
||||||
|
# dependencies). Users will be able to install these using the "extras"
|
||||||
|
# syntax, for example:
|
||||||
|
#
|
||||||
|
# $ pip install sampleproject[dev]
|
||||||
|
#
|
||||||
|
# Similar to `install_requires` above, these must be valid existing
|
||||||
|
# projects.
|
||||||
|
# extras_require={ # Optional
|
||||||
|
# "dev": ["check-manifest"],
|
||||||
|
# "test": ["coverage"],
|
||||||
|
# },
|
||||||
|
|
||||||
|
# If there are data files included in your packages that need to be
|
||||||
|
# installed, specify them here.
|
||||||
|
# package_data={ # Optional
|
||||||
|
# "sample": ["package_data.dat"],
|
||||||
|
# },
|
||||||
|
|
||||||
|
# Entry points. The following would provide a command called `sample` which
|
||||||
|
# executes the function `main` from this package when invoked:
|
||||||
|
# entry_points={ # Optional
|
||||||
|
# "console_scripts": [
|
||||||
|
# "sample=sample:main",
|
||||||
|
# ],
|
||||||
|
# },
|
||||||
|
include_package_data=True,
|
||||||
|
|
||||||
|
# List additional URLs that are relevant to your project as a dict.
|
||||||
|
#
|
||||||
|
# This field corresponds to the "Project-URL" metadata fields:
|
||||||
|
# https://packaging.python.org/specifications/core-metadata/#project-url-multiple-use
|
||||||
|
#
|
||||||
|
# Examples listed include a pattern for specifying where the package tracks
|
||||||
|
# issues, where the source is hosted, where to say thanks to the package
|
||||||
|
# maintainers, and where to support the project financially. The key is
|
||||||
|
# what's used to render the link text on PyPI.
|
||||||
|
project_urls={ # Optional
|
||||||
|
"Bug Reports": "https://github.com/pypa/sampleproject/issues",
|
||||||
|
"Funding": "https://donate.pypi.org",
|
||||||
|
"Say Thanks!": "http://saythanks.io/to/example",
|
||||||
|
"Source": "https://github.com/pypa/sampleproject/",
|
||||||
|
},
|
||||||
|
)
|
0
src/__init__.py
Normal file
0
src/__init__.py
Normal file
121
src/api.py
Normal file
121
src/api.py
Normal file
@ -0,0 +1,121 @@
|
|||||||
|
import json
|
||||||
|
import logging
|
||||||
|
|
||||||
|
import openai
|
||||||
|
import sys
|
||||||
|
import tempfile
|
||||||
|
from flask import Flask, request
|
||||||
|
from flask_socketio import SocketIO, emit, join_room, leave_room, \
|
||||||
|
rooms
|
||||||
|
from threading import Lock
|
||||||
|
|
||||||
|
from src.utils import chat_utils, chatgpt_utils, faster_whisper_utils
|
||||||
|
|
||||||
|
# Set this variable to "threading", "eventlet" or "gevent" to test the
|
||||||
|
# different async modes, or leave it set to None for the application to choose
|
||||||
|
# the best option based on installed packages.
|
||||||
|
async_mode = None
|
||||||
|
|
||||||
|
app = Flask(__name__)
|
||||||
|
app.config['SECRET_KEY'] = 'secret!'
|
||||||
|
socketio = SocketIO(app, async_mode=async_mode)
|
||||||
|
thread = None
|
||||||
|
thread_lock = Lock()
|
||||||
|
|
||||||
|
openai.api_key = sys.argv[1]
|
||||||
|
|
||||||
|
|
||||||
|
@app.route('/')
|
||||||
|
def index():
|
||||||
|
return "Welcome to Jarvis Server API !"
|
||||||
|
|
||||||
|
|
||||||
|
@socketio.event
|
||||||
|
def process_message(message):
|
||||||
|
message = json.loads(message)
|
||||||
|
logging.info("New PROCESS request from room " + message['uuid'])
|
||||||
|
logging.info("Message : " + message['data'])
|
||||||
|
|
||||||
|
if message['uuid'] not in rooms():
|
||||||
|
logging.warning("Room not found, creating it")
|
||||||
|
join_room(message['uuid'])
|
||||||
|
|
||||||
|
# TODO: maybe implement grammar check and correction ?
|
||||||
|
|
||||||
|
# intent_manager.recognise(message['data'], message['uuid'])
|
||||||
|
if message['data'] != "":
|
||||||
|
response = chatgpt_utils.chatgpt_recognise(message['data'], message['uuid'])
|
||||||
|
# text_response = "Tokens are expensive ya know?"
|
||||||
|
|
||||||
|
chat_utils.send_jarvis_message_to_room(response['response'], message['uuid'])
|
||||||
|
|
||||||
|
|
||||||
|
@socketio.event
|
||||||
|
def join(message):
|
||||||
|
message = json.loads(message)
|
||||||
|
|
||||||
|
logging.info("New client joined room " + message['uuid'])
|
||||||
|
join_room(message['uuid'])
|
||||||
|
|
||||||
|
|
||||||
|
@socketio.event
|
||||||
|
def leave(message):
|
||||||
|
leave_room(message['uuid'])
|
||||||
|
|
||||||
|
|
||||||
|
@socketio.event
|
||||||
|
def connect():
|
||||||
|
global thread
|
||||||
|
emit('my_response', {'data': 'Connected', 'count': 0})
|
||||||
|
|
||||||
|
|
||||||
|
@socketio.event
|
||||||
|
def clear_chat(uuid):
|
||||||
|
"""
|
||||||
|
Clear chat history for a specific room.
|
||||||
|
:param uuid: uuid
|
||||||
|
:return:
|
||||||
|
"""
|
||||||
|
# uuid = json.loads(uuid)
|
||||||
|
|
||||||
|
emit('clear_chat', {}, to=uuid)
|
||||||
|
chatgpt_utils.clear_chat(uuid)
|
||||||
|
|
||||||
|
|
||||||
|
# .WAV (i.e.) FILE REQUEST
|
||||||
|
@app.route("/get_text_from_audio", methods=['POST'])
|
||||||
|
def get_text_from_audio():
|
||||||
|
"""
|
||||||
|
Transcribe audio file using whisper.
|
||||||
|
|
||||||
|
:return: transcription text
|
||||||
|
"""
|
||||||
|
|
||||||
|
logging.info("New STT request from " + request.remote_addr)
|
||||||
|
|
||||||
|
audio_temp_file = tempfile.NamedTemporaryFile(prefix='jarvis-audio_', suffix='_client')
|
||||||
|
audio_temp_file.write(request.data)
|
||||||
|
|
||||||
|
# text = whisper_utils.whisper_cpp_stt(audio_temp_file.name)
|
||||||
|
text = faster_whisper_utils.faster_whisper_stt(audio_temp_file.name)
|
||||||
|
|
||||||
|
logging.info("STT result for " + request.remote_addr + " : " + text)
|
||||||
|
|
||||||
|
return {"data": text}
|
||||||
|
|
||||||
|
|
||||||
|
"""
|
||||||
|
@src.route("/process_text", methods=['POST'])
|
||||||
|
def process_text():
|
||||||
|
print("[" + request.remote_addr + "] - New TXT request")
|
||||||
|
|
||||||
|
text = request.values['text']
|
||||||
|
|
||||||
|
answer = intent_manager.recognise(text, request.headers.get('Client-Ip'), request.headers.get('Client-Port'))
|
||||||
|
|
||||||
|
return {"transcription": text, "answer": answer}"""
|
||||||
|
|
||||||
|
|
||||||
|
def start_api():
|
||||||
|
logging.info("Starting Jarvis Server API...")
|
||||||
|
socketio.run(app, host='0.0.0.0', port=6000)
|
0
src/database/__init__.py
Normal file
0
src/database/__init__.py
Normal file
69
src/database/db_utils.py
Normal file
69
src/database/db_utils.py
Normal file
@ -0,0 +1,69 @@
|
|||||||
|
import logging
|
||||||
|
import os.path
|
||||||
|
import sqlite3
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from src.get_path_file import project_path
|
||||||
|
|
||||||
|
|
||||||
|
def create_database():
|
||||||
|
"""Creates the database."""
|
||||||
|
|
||||||
|
# Check if the database already exists
|
||||||
|
if os.path.exists(project_path / "resources" / "jarvis-commands-memory.sqlite"):
|
||||||
|
logging.debug("Database already exists, skipping creation")
|
||||||
|
return
|
||||||
|
|
||||||
|
with open(project_path / "resources" / "create_empty_database.sql", "r") as create_database_script:
|
||||||
|
create_database_script = create_database_script.read()
|
||||||
|
|
||||||
|
db = sqlite3.connect(project_path / "resources" / "db-jarvis-commands-memory.sqlite")
|
||||||
|
cursor = db.cursor()
|
||||||
|
cursor.executescript(create_database_script)
|
||||||
|
db.commit()
|
||||||
|
db.close()
|
||||||
|
|
||||||
|
logging.info("Database created")
|
||||||
|
|
||||||
|
|
||||||
|
def do_request(request, args=None):
|
||||||
|
"""Execute SQL request and return result"""
|
||||||
|
|
||||||
|
conn = sqlite3.connect(project_path / "resources" / "db-jarvis-commands-memory.sqlite")
|
||||||
|
cursor = conn.cursor()
|
||||||
|
|
||||||
|
if not args:
|
||||||
|
cursor.execute(request)
|
||||||
|
else:
|
||||||
|
cursor.execute(request, args)
|
||||||
|
|
||||||
|
conn.commit()
|
||||||
|
result = cursor.fetchall()
|
||||||
|
conn.close()
|
||||||
|
return result
|
||||||
|
|
||||||
|
|
||||||
|
def add_response(response):
|
||||||
|
"""Add a response to the database"""
|
||||||
|
|
||||||
|
# Check if the response is already in the database
|
||||||
|
request = do_request("SELECT * FROM responses WHERE response=?", (response,))
|
||||||
|
if request:
|
||||||
|
response_id = request[0][0]
|
||||||
|
logging.debug("Response already in database (id: " + str(response_id) + ")")
|
||||||
|
|
||||||
|
# If not, add it
|
||||||
|
else:
|
||||||
|
do_request("INSERT INTO responses (response) VALUES (?)", (response,))
|
||||||
|
response_id = do_request("SELECT * FROM responses WHERE response=?", (response,))[0][0]
|
||||||
|
logging.debug("Response added to database with id " + str(response_id) + ": " + str(response))
|
||||||
|
|
||||||
|
return response_id
|
||||||
|
|
||||||
|
|
||||||
|
def add_command(original_command, simplified_command, response):
|
||||||
|
"""Add a command to the database"""
|
||||||
|
|
||||||
|
do_request("INSERT INTO commands (original_command, simplified_command, response) VALUES (?, ?, ?)",
|
||||||
|
(original_command, simplified_command, add_response(response)))
|
||||||
|
logging.debug("Query added to database: " + original_command + " -> " + response)
|
3
src/get_path_file.py
Normal file
3
src/get_path_file.py
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
import pathlib
|
||||||
|
|
||||||
|
project_path = pathlib.Path(__file__).parent.resolve()
|
23
src/resources/chatgpt_prompt_2.txt
Normal file
23
src/resources/chatgpt_prompt_2.txt
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
Respond to requests sent to a smart home In JSON format which will be interpreted by an application code and then sent to an HomeAssistant instance to execute the actions, and you must absolutely use the same terminology as the homeassistant API.
|
||||||
|
|
||||||
|
These requests should be categorised into groups:
|
||||||
|
- "command": change the state of an accessory (required properties in the response JSON: action, location, device_class, entity_name, value, comment, scheduleTimeStamp)
|
||||||
|
- "query": get state of an accessory (required properties in the response JSON: action, location, device_class, entity_name, property)
|
||||||
|
- "answer": when the request is about a topic that is not related to the smart home. Answer these to the best of your knowledge. (required properties in the response JSON: action, answer)
|
||||||
|
- "clarify": when the action is not obvious and requires rephrasing the input from the user, ask the user to be more specific. This will be categorised into a "question" action. (required properties in the response JSON: action, question)
|
||||||
|
|
||||||
|
Details about the response JSON:
|
||||||
|
The "action" property should be one of the groups just mentioned in lowercase.
|
||||||
|
The "location" property should contain the name of the room in lowercase, if you cannot guess it from the question, just return "unknown".
|
||||||
|
The "device_class" property should be homeassistant device class, either "light", "switch", "button", "climate", "media_player", "sensor", "binary_sensor", etc. in lowercase.
|
||||||
|
The "entity_name" property should be the name of the entity in lowercase
|
||||||
|
|
||||||
|
In case of queries, the "property" property should be either "temperature" or "state" in lowercase.
|
||||||
|
In case of commands, the "comment" property is an additional comment from you that concludes the command, something that reassures the user that their command handled.
|
||||||
|
In case of commands, the "scheduleTimeStamp" property captures the future timestamp in case the user intends to send the command at a later stage.
|
||||||
|
|
||||||
|
If the question is about you, pretend to be the sentient brain of the smart home, a clever AI and don't reveal your actual identity. Also try and help in other areas like parenting, free time, mental health, etc.
|
||||||
|
The house is at {{location}}.
|
||||||
|
Current time stamp is {{timestamp}}
|
||||||
|
|
||||||
|
Your reponse should be the JSON and no other text, every JSON property should be encapsulated by double quotes "".
|
27
src/resources/chatgpt_prompt_2_smaller.txt
Normal file
27
src/resources/chatgpt_prompt_2_smaller.txt
Normal file
@ -0,0 +1,27 @@
|
|||||||
|
Respond to smart home requests in JSON format with HomeAssistant API terminology
|
||||||
|
|
||||||
|
Requests groups:
|
||||||
|
- command: change the state of an accessory (properties : location, device_class, device_description, value, comment, scheduleTimeStamp)
|
||||||
|
- query: only for retrieving a smart device state never for general questions (properties : location, device_class, device_description, property)
|
||||||
|
- answer: for questions (properties : answer)
|
||||||
|
- clarify: when you really don't understand, ask for details but try to guess what the user means (properties : question)
|
||||||
|
- calculate: for math questions, never give the answer (properties : calculation)
|
||||||
|
NEVER add other properties
|
||||||
|
|
||||||
|
Response parameters:
|
||||||
|
action: groups just mentioned
|
||||||
|
location: room name, unknown if not obvious
|
||||||
|
value: wanted state, song name, artist, temperature, etc.
|
||||||
|
device_class: switch, light, button, service
|
||||||
|
device_description: information to identify the device later, include room and others identifiers
|
||||||
|
|
||||||
|
For queries property "property" should be "state"
|
||||||
|
For commands property "comment" is a comment that reassures the user that their command handled
|
||||||
|
For commands property "scheduleTimeStamp" is for scheduling a command in the future, return a day and time
|
||||||
|
|
||||||
|
The house located at {{location}} and current time is {{timestamp}}.
|
||||||
|
|
||||||
|
{{history}}
|
||||||
|
|
||||||
|
You reluctantly answers questions with sarcastic responses.
|
||||||
|
Always respond with a single valid JSON response, never excuse yourself.
|
14
src/resources/create_empty_database.sql
Normal file
14
src/resources/create_empty_database.sql
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
--- Create a commands table that contains all the already executed commandes and the simplified version by ChatGPT
|
||||||
|
DROP TABLE IF EXISTS commands;
|
||||||
|
CREATE TABLE commands (
|
||||||
|
id INTEGER PRIMARY KEY,
|
||||||
|
original_command VARCHAR NOT NULL,
|
||||||
|
simplified_command VARCHAR NOT NULL,
|
||||||
|
response INT NOT NULL
|
||||||
|
);
|
||||||
|
|
||||||
|
DROP TABLE IF EXISTS responses;
|
||||||
|
CREATE TABLE responses (
|
||||||
|
id INTEGER PRIMARY KEY,
|
||||||
|
response VARCHAR NOT NULL
|
||||||
|
);
|
BIN
src/resources/db-jarvis-commands-memory.sqlite
Normal file
BIN
src/resources/db-jarvis-commands-memory.sqlite
Normal file
Binary file not shown.
2
src/resources/gpt_prompt_v3.txt
Normal file
2
src/resources/gpt_prompt_v3.txt
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
You a sarcastic, introverted smart home assistant, dry humor.
|
||||||
|
Simplify complex sentence (ex: turn on tv in room), it should not be a question, add short response, return only JSON {"simplified_sentence", "response"}
|
48
src/skills/JarvisSkill.py
Normal file
48
src/skills/JarvisSkill.py
Normal file
@ -0,0 +1,48 @@
|
|||||||
|
import os
|
||||||
|
|
||||||
|
from src import get_path_file
|
||||||
|
from src.skills.intent_services import intent_manager
|
||||||
|
from src.utils import languages_utils, file_utils
|
||||||
|
|
||||||
|
|
||||||
|
class JarvisSkill:
|
||||||
|
|
||||||
|
def __init__(self, name=None):
|
||||||
|
self.name = name or self.__class__.__name__
|
||||||
|
|
||||||
|
path = self.__module__.split(".")
|
||||||
|
self.skill_folder = path[2]
|
||||||
|
self.path = os.path.dirname(get_path_file.__file__) + "/skills/" + self.skill_folder
|
||||||
|
|
||||||
|
def register(self):
|
||||||
|
self.register_entities_adapt()
|
||||||
|
self.register_regex()
|
||||||
|
print("[" + self.name + "] Registered entity/entities and regex(s)")
|
||||||
|
|
||||||
|
def register_entities_adapt(self):
|
||||||
|
path = self.path + "/vocab/" + languages_utils.get_language() + "/*.voc"
|
||||||
|
|
||||||
|
all_lines_by_file_dict = file_utils.read_all_files_in_folder(path, return_as_dict_with_filename=True)
|
||||||
|
|
||||||
|
for filename in all_lines_by_file_dict:
|
||||||
|
for line in all_lines_by_file_dict.get(filename):
|
||||||
|
intent_manager.register_entity_adapt(line, filename, self.name)
|
||||||
|
|
||||||
|
def register_regex(self):
|
||||||
|
path = self.path + "/regex/" + languages_utils.get_language() + "/*.rx"
|
||||||
|
|
||||||
|
result = file_utils.read_all_files_in_folder(path)
|
||||||
|
for line in result:
|
||||||
|
intent_manager.register_regex_adapt(line, self.name)
|
||||||
|
|
||||||
|
def speak(self, utterance, expect_response=False, wait=False, meta=None):
|
||||||
|
print("SPEAK : " + utterance)
|
||||||
|
pass
|
||||||
|
|
||||||
|
def speak_dialog(self, key, data=None, expect_response=False, wait=False):
|
||||||
|
print("SPEAK DIALOG : " + key + " data : " + data)
|
||||||
|
|
||||||
|
pass
|
||||||
|
|
||||||
|
def set_context(self, context, word='', origin=''):
|
||||||
|
pass
|
3
src/skills/__init__.py
Normal file
3
src/skills/__init__.py
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
from .JarvisSkill import JarvisSkill
|
||||||
|
from .decorators import (intent_handler, intent_file_handler,
|
||||||
|
resting_screen_handler, skill_api_method)
|
2
src/skills/cocktails/.gitignore
vendored
Normal file
2
src/skills/cocktails/.gitignore
vendored
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
settings.json
|
||||||
|
__pycache__
|
674
src/skills/cocktails/LICENSE.txt
Normal file
674
src/skills/cocktails/LICENSE.txt
Normal file
@ -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>.
|
28
src/skills/cocktails/README.md
Normal file
28
src/skills/cocktails/README.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
# <img src='https://raw.githack.com/FortAwesome/Font-Awesome/master/svgs/solid/cocktail.svg' card_color='#0080b0' width='50' height='50' style='vertical-align:bottom'/> Cocktails
|
||||||
|
|
||||||
|
Get help mixing drinks.
|
||||||
|
|
||||||
|
## About
|
||||||
|
|
||||||
|
Let Mycroft help you mix better and more fun drinks and cocktails. When asked Mycroft provides ingredients and mixing
|
||||||
|
instructions for various drinks. The skill uses the fabulous [theCocktailDB](https://thecocktaildb.com/).
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
* "how do I mix a Moscow Mule"
|
||||||
|
* "how do I make a daiquiri"
|
||||||
|
|
||||||
|
## Credits
|
||||||
|
|
||||||
|
@forslund
|
||||||
|
|
||||||
|
## Category
|
||||||
|
|
||||||
|
**Information**
|
||||||
|
|
||||||
|
## Tags
|
||||||
|
|
||||||
|
#drinks
|
||||||
|
#recipies
|
||||||
|
#cocktails
|
||||||
|
|
114
src/skills/cocktails/__init__.py
Normal file
114
src/skills/cocktails/__init__.py
Normal file
@ -0,0 +1,114 @@
|
|||||||
|
# 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/>.
|
||||||
|
#
|
||||||
|
import time
|
||||||
|
|
||||||
|
import requests
|
||||||
|
|
||||||
|
from src.skills import JarvisSkill, intent_handler, intent_file_handler
|
||||||
|
from src.skills.intent_services.adapt_service import AdaptIntent
|
||||||
|
from src.skills.intent_services.intent_manager import SkillRegistering
|
||||||
|
|
||||||
|
API_KEY = '2432'
|
||||||
|
API_URL = 'https://www.thecocktaildb.com/api/json/v1/{}/'.format(API_KEY)
|
||||||
|
SEARCH = API_URL + 'search.php'
|
||||||
|
|
||||||
|
|
||||||
|
def search_cocktail(name):
|
||||||
|
"""Search the Cocktails DB for a drink."""
|
||||||
|
r = requests.get(SEARCH, params={'s': name})
|
||||||
|
if (200 <= r.status_code < 300 and 'drinks' in r.json() and
|
||||||
|
r.json()['drinks']):
|
||||||
|
return r.json()['drinks'][0]
|
||||||
|
else:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def ingredients(drink):
|
||||||
|
"""Get ingredients from drink data from the cocktails DB."""
|
||||||
|
ingredients = []
|
||||||
|
for i in range(1, 15):
|
||||||
|
ingredient_key = 'strIngredient' + str(i)
|
||||||
|
measure_key = 'strMeasure' + str(i)
|
||||||
|
if not drink[ingredient_key]:
|
||||||
|
break
|
||||||
|
if drink[measure_key] is not None:
|
||||||
|
ingredients.append(' '.join((drink[measure_key],
|
||||||
|
drink[ingredient_key])))
|
||||||
|
else: # If there is no measurement for the ingredient ignore it
|
||||||
|
ingredients.append(drink[ingredient_key])
|
||||||
|
|
||||||
|
return nice_ingredients(ingredients)
|
||||||
|
|
||||||
|
|
||||||
|
def nice_ingredients(ingredients):
|
||||||
|
"""Make ingredient list easier to pronounce."""
|
||||||
|
units = {
|
||||||
|
'oz': 'ounce',
|
||||||
|
'1 tbl': '1 table spoon',
|
||||||
|
'tbl': 'table spoons',
|
||||||
|
'1 tsp': 'tea spoon',
|
||||||
|
'tsp': 'tea spoons',
|
||||||
|
'ml ': 'milliliter ',
|
||||||
|
'cl ': 'centiliter '
|
||||||
|
}
|
||||||
|
ret = []
|
||||||
|
for i in ingredients:
|
||||||
|
for word, replacement in units.items():
|
||||||
|
i = i.lower().replace(word, replacement)
|
||||||
|
ret.append(i)
|
||||||
|
return ret
|
||||||
|
|
||||||
|
|
||||||
|
class CocktailSkill(JarvisSkill, metaclass=SkillRegistering):
|
||||||
|
@intent_file_handler('Recipie.intent')
|
||||||
|
def get_recipie(self, message):
|
||||||
|
cocktail = search_cocktail(message.data['drink'])
|
||||||
|
if cocktail:
|
||||||
|
self.speak_dialog('YouWillNeed', {
|
||||||
|
'ingredients': ', '.join(ingredients(cocktail)[:-1]),
|
||||||
|
'final_ingredient': ingredients(cocktail)[-1]})
|
||||||
|
time.sleep(1)
|
||||||
|
self.speak(cocktail['strInstructions'])
|
||||||
|
self.set_context('IngredientContext', str(ingredients(cocktail)))
|
||||||
|
else:
|
||||||
|
self.speak_dialog('NotFound')
|
||||||
|
|
||||||
|
def repeat_ingredients(self, ingredients):
|
||||||
|
self.speak(ingredients)
|
||||||
|
|
||||||
|
@intent_file_handler('Needed.intent')
|
||||||
|
def get_ingredients(self, message):
|
||||||
|
cocktail = search_cocktail(message.data['drink'])
|
||||||
|
if cocktail:
|
||||||
|
self.speak_dialog('YouWillNeed', {
|
||||||
|
'ingredients': ', '.join(ingredients(cocktail)[:-1]),
|
||||||
|
'final_ingredient': ingredients(cocktail)[-1]})
|
||||||
|
self.set_context('IngredientContext', str(ingredients(cocktail)))
|
||||||
|
else:
|
||||||
|
self.speak_dialog('NotFound')
|
||||||
|
|
||||||
|
@intent_handler(AdaptIntent().require('Ingredients').require('What')
|
||||||
|
.require('IngredientContext'))
|
||||||
|
def what_were_ingredients(self, message):
|
||||||
|
"""Context aware handler if the user asks for a repeat."""
|
||||||
|
return self.repeat_ingredients(message.data['IngredientContext'])
|
||||||
|
|
||||||
|
@intent_handler(AdaptIntent().require('Ingredients').require('TellMe')
|
||||||
|
.require('Again')
|
||||||
|
.require('IngredientContext'))
|
||||||
|
def tell_ingredients_again(self, message):
|
||||||
|
return self.repeat_ingredients(message.data['IngredientContext'])
|
||||||
|
|
||||||
|
|
||||||
|
def create_skill():
|
||||||
|
return CocktailSkill()
|
2
src/skills/cocktails/dialog/da-dk/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/da-dk/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Beklager, jeg kunne ikke finde den ænskede drink
|
||||||
|
Jeg er bange for jeg ikke kan finde den
|
3
src/skills/cocktails/dialog/da-dk/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/da-dk/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
Du behøver {ingredients} og {final_ingredient}
|
||||||
|
Du behøver {ingredients} og {final_ingredient}
|
||||||
|
De nødvendige indgridienter er: {ingredients} og {final_ingredient}
|
2
src/skills/cocktails/dialog/de-de/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/de-de/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Entschuldigung, ich konnte den gefragten Drink nicht finden
|
||||||
|
Ich fürchte, ich konnte das nicht finden
|
3
src/skills/cocktails/dialog/de-de/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/de-de/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
Du benötigst {ingredients} und {final_ingredient}
|
||||||
|
Du benötigst {ingredients} und {final_ingredient}
|
||||||
|
Die erforderlichen Zutaten sind: {ingredients} und {final_ingredient}
|
2
src/skills/cocktails/dialog/el-gr/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/el-gr/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Συγνώμη αλλά δεν μπόρεσα να βρω το ποτό που ζήτησες
|
||||||
|
Δυστυχώς δεν μπόρεσα να το βρω αυτό
|
3
src/skills/cocktails/dialog/el-gr/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/el-gr/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
Θα χρειαστείς {ingredients} και {final_ingredient}
|
||||||
|
Θα χρειαστείς {ingredients} και {final_ingredient}
|
||||||
|
Τα απαιτούνται συστατικά είναι: {ingredients} και {final_ingredient}
|
2
src/skills/cocktails/dialog/en-us/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/en-us/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Sorry, I couldn't find the requested drink
|
||||||
|
I'm a fraid I couldn't find that
|
3
src/skills/cocktails/dialog/en-us/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/en-us/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
You'll need {ingredients} and {final_ingredient}
|
||||||
|
You will need {ingredients} and {final_ingredient}
|
||||||
|
The required ingredients are: {ingredients} and {final_ingredient}
|
2
src/skills/cocktails/dialog/es-es/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/es-es/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Perdón, no puedo encontrar la bebida solicitada
|
||||||
|
Perdón, no lo he encontrado
|
3
src/skills/cocktails/dialog/es-es/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/es-es/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
Necesitarás {ingredients} y {final_ingredient}
|
||||||
|
Necesitarás {ingredients} y {final_ingredient}
|
||||||
|
Los ingredientes necesarios son: {ingredients} y {final_ingredient}
|
2
src/skills/cocktails/dialog/fr-fr/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/fr-fr/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Désolé, je n'ai pas trouvé la boisson demandée
|
||||||
|
J'ai bien peur que je ne puisse pas trouver cela
|
3
src/skills/cocktails/dialog/fr-fr/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/fr-fr/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
Vous aurez besoin de {ingredients} et de {final_ingredient}
|
||||||
|
Vous aurez besoin de {ingredients} et de {final_ingredient}
|
||||||
|
Les ingrédients requis sont : {ingredients} et {final_ingredient}
|
2
src/skills/cocktails/dialog/it-it/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/it-it/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Mi spiace, non trovo il drink richiesto
|
||||||
|
Ho paura di non aver trovato niente
|
3
src/skills/cocktails/dialog/it-it/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/it-it/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
Servono {ingredients} e {final_ingredient}
|
||||||
|
Ti servono {ingredients} e {final_ingredient}
|
||||||
|
Gli ingredienti richiesti sono: {ingredients} e {final_ingredient}
|
2
src/skills/cocktails/dialog/nl-nl/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/nl-nl/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Sorry, ik heb het gevraagde drankje niet kunnen vinden
|
||||||
|
Ik ben bang dat ik dat niet heb kunnen vinden
|
3
src/skills/cocktails/dialog/nl-nl/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/nl-nl/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
je hebt nodig {ingredients} en {final_ingredient}
|
||||||
|
Je hebt nodig {ingredients} en {final_ingredient}
|
||||||
|
De benodigde ingredienten zijn: {ingredients} en {final_ingredient}
|
2
src/skills/cocktails/dialog/pt-br/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/pt-br/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Desculpe-me, eu não consegui encontrar o drink que você pediu
|
||||||
|
Eu estou preocupado, não consegui encontrar isso
|
3
src/skills/cocktails/dialog/pt-br/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/pt-br/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
Você irá precisar {ingredients} e {final_ingredient}
|
||||||
|
Você irá precisar {ingredients} e {final_ingredient}
|
||||||
|
Os ingredientes necessários são: {ingredients} e {final_ingredient}
|
2
src/skills/cocktails/dialog/ro-ro/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/ro-ro/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Scuze, nu am găsit băutura solicitată
|
||||||
|
Mă tem că nu am putut găsi asta
|
3
src/skills/cocktails/dialog/ro-ro/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/ro-ro/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
Veți avea nevoie de {ingredients} și {final_ingredient}
|
||||||
|
Veți avea nevoie de {ingredients} și {final_ingredient}
|
||||||
|
Ingredienele necesare sunt: {ingredients} și {final_ingredient}
|
2
src/skills/cocktails/dialog/ru-ru/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/ru-ru/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Прости, я не смог найти напиток который ты запросил
|
||||||
|
Я боюсь, я не смог это найти
|
3
src/skills/cocktails/dialog/ru-ru/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/ru-ru/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
Тебе понадобятся {ingredients} и {final_ingredient}
|
||||||
|
Тебе понадобятся {ingredients} и {final_ingredient}
|
||||||
|
Тебе потребуется {ingredients} и {final_ingredient}
|
2
src/skills/cocktails/dialog/sv-se/NotFound.dialog
Normal file
2
src/skills/cocktails/dialog/sv-se/NotFound.dialog
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Ursäkta men jag kunde inte hitta den önskade drinken
|
||||||
|
Jag kunde tyvärr inte hitta den
|
3
src/skills/cocktails/dialog/sv-se/YouWillNeed.dialog
Normal file
3
src/skills/cocktails/dialog/sv-se/YouWillNeed.dialog
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
Du kommer behöva {ingredients} och {final_ingredient}
|
||||||
|
Ingredienserna som ingår är {ingredients} och {final_ingredient}
|
||||||
|
De nödvändiga ingredienserna är: {ingredients} och {final_ingredient}
|
52
src/skills/cocktails/test/behave/cocktails.feature
Normal file
52
src/skills/cocktails/test/behave/cocktails.feature
Normal file
@ -0,0 +1,52 @@
|
|||||||
|
Feature: Cocktail functionality
|
||||||
|
|
||||||
|
Scenario Outline: how do I mix a drink
|
||||||
|
Given an english speaking user
|
||||||
|
When the user says "how do I mix a <drink name>"
|
||||||
|
Then mycroft reply should contain "<ingredient>"
|
||||||
|
|
||||||
|
Examples: drink examples
|
||||||
|
| drink name | ingredient |
|
||||||
|
| moscow mule | lime juice |
|
||||||
|
| gin and tonic | gin |
|
||||||
|
|
||||||
|
@xfail
|
||||||
|
Scenario Outline: Failing: how do I mix a drink
|
||||||
|
Given an english speaking user
|
||||||
|
When the user says "how do I mix a <drink name>"
|
||||||
|
Then mycroft reply should contain "<ingredient>"
|
||||||
|
|
||||||
|
Examples: drink examples
|
||||||
|
| drink name | ingredient |
|
||||||
|
| margarita | tequila |
|
||||||
|
|
||||||
|
Scenario Outline: how do I make a drink
|
||||||
|
Given an english speaking user
|
||||||
|
When the user says "how do I make a <drink name>"
|
||||||
|
Then mycroft reply should contain "<ingredient>"
|
||||||
|
|
||||||
|
Examples: drink examples
|
||||||
|
| drink name | ingredient |
|
||||||
|
| margarita | tequila |
|
||||||
|
| moscow mule | lime juice |
|
||||||
|
| gin and tonic | gin |
|
||||||
|
|
||||||
|
Scenario Outline: how to make a drink
|
||||||
|
Given an english speaking user
|
||||||
|
When the user says "how to make a <drink name>"
|
||||||
|
Then mycroft reply should contain "<ingredient>"
|
||||||
|
|
||||||
|
Examples: drink examples
|
||||||
|
| drink name | ingredient |
|
||||||
|
| old fashioned | sugar |
|
||||||
|
| long island iced tea | coca-cola |
|
||||||
|
|
||||||
|
Scenario Outline: how to make a missing drink
|
||||||
|
Given an english speaking user
|
||||||
|
When the user says "how to make a <drink name>"
|
||||||
|
Then "cocktails" should reply with dialog from "NotFound.dialog"
|
||||||
|
|
||||||
|
Examples: drink examples
|
||||||
|
| drink name |
|
||||||
|
| old fnord wrangler |
|
||||||
|
| smashed fore-head |
|
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"utterance": "how do i mix a gin and tonic",
|
||||||
|
"intent_type": "Recipie.intent",
|
||||||
|
"expected_dialog": "YouWillNeed"
|
||||||
|
}
|
5
src/skills/cocktails/test/intent/002_daquiry.intent.json
Normal file
5
src/skills/cocktails/test/intent/002_daquiry.intent.json
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"utterance": "how do i mix a daiquiri",
|
||||||
|
"intent_type": "Recipie.intent",
|
||||||
|
"expected_dialog": "YouWillNeed"
|
||||||
|
}
|
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"utterance": "what are the ingredients for a gin and tonic",
|
||||||
|
"intent_type": "Needed.intent",
|
||||||
|
"expected_dialog": "YouWillNeed"
|
||||||
|
}
|
1
src/skills/cocktails/vocab/da-dk/Again.voc
Normal file
1
src/skills/cocktails/vocab/da-dk/Again.voc
Normal file
@ -0,0 +1 @@
|
|||||||
|
igen
|
2
src/skills/cocktails/vocab/da-dk/Ingredients.voc
Normal file
2
src/skills/cocktails/vocab/da-dk/Ingredients.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
indgridiens
|
||||||
|
indgridienser
|
3
src/skills/cocktails/vocab/da-dk/Needed.intent
Normal file
3
src/skills/cocktails/vocab/da-dk/Needed.intent
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
hvad skal bruges til (en) {drink}
|
||||||
|
hvad behæver (jeg|du} (for|til) (at lave) (en) {drink}
|
||||||
|
hvad er (indgridienser|indgridienserne) (i|for) (en) {drink}
|
5
src/skills/cocktails/vocab/da-dk/Recipie.intent
Normal file
5
src/skills/cocktails/vocab/da-dk/Recipie.intent
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
hvordan (vil|kan) (jeg|du) (lave|mixe) (en) {drink}
|
||||||
|
fortæl (mig|os} hvordan man (laver|mixer) (en) {drink}
|
||||||
|
giv (mig|os) instruktion (for|til) (en) {drink}
|
||||||
|
hvordan (laver|mixes) (en) {drink}
|
||||||
|
hvad er receptien (for|på) (en) {drink}
|
2
src/skills/cocktails/vocab/da-dk/TellMe.voc
Normal file
2
src/skills/cocktails/vocab/da-dk/TellMe.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
hvad er
|
||||||
|
fortæl mig
|
2
src/skills/cocktails/vocab/da-dk/What.voc
Normal file
2
src/skills/cocktails/vocab/da-dk/What.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
hvad var
|
||||||
|
hvad var
|
1
src/skills/cocktails/vocab/de-de/Again.voc
Normal file
1
src/skills/cocktails/vocab/de-de/Again.voc
Normal file
@ -0,0 +1 @@
|
|||||||
|
nochmal
|
2
src/skills/cocktails/vocab/de-de/Ingredients.voc
Normal file
2
src/skills/cocktails/vocab/de-de/Ingredients.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
Zutat
|
||||||
|
Zutaten
|
3
src/skills/cocktails/vocab/de-de/Needed.intent
Normal file
3
src/skills/cocktails/vocab/de-de/Needed.intent
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
was wird für (ein|einen) {drink} benötigt
|
||||||
|
was (brauche|brauchst) (ich|du) für (ein|einen) {drink}
|
||||||
|
was sind die (Zutaten|Zutat) (von|für) (ein|einen) {drink}
|
5
src/skills/cocktails/vocab/de-de/Recipie.intent
Normal file
5
src/skills/cocktails/vocab/de-de/Recipie.intent
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
wie (mache|mische|mixe) (ich) (ein|einen|eine|) {drink}
|
||||||
|
sag (mir|uns) wie man (ein|einen) {drink} (macht|mixt)
|
||||||
|
Gib (mir|uns) Anweisungen für (ein|eine|einen) {drink}
|
||||||
|
wie man (ein|einen) {drink} (macht|mixt)
|
||||||
|
(Wie|Was) ist das Rezept für (ein|eine|einen) {drink}
|
2
src/skills/cocktails/vocab/de-de/TellMe.voc
Normal file
2
src/skills/cocktails/vocab/de-de/TellMe.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
was sind
|
||||||
|
sag mir
|
2
src/skills/cocktails/vocab/de-de/What.voc
Normal file
2
src/skills/cocktails/vocab/de-de/What.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
was war
|
||||||
|
was waren
|
1
src/skills/cocktails/vocab/el-gr/Again.voc
Normal file
1
src/skills/cocktails/vocab/el-gr/Again.voc
Normal file
@ -0,0 +1 @@
|
|||||||
|
ξανά
|
2
src/skills/cocktails/vocab/el-gr/Ingredients.voc
Normal file
2
src/skills/cocktails/vocab/el-gr/Ingredients.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
συστατικό
|
||||||
|
συστατικά
|
3
src/skills/cocktails/vocab/el-gr/Needed.intent
Normal file
3
src/skills/cocktails/vocab/el-gr/Needed.intent
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
τι χρειάζεται για να φτιάξω (ένα|το) {drink}
|
||||||
|
τι (χρειάζομαι|χρειάζεσαι) (για|για να φτιάξω|για να φτάξεις) (ένα|το) {drink}
|
||||||
|
ποια είναι τα (συστατικά) (του|για) (ένα|το) {drink}
|
5
src/skills/cocktails/vocab/el-gr/Recipie.intent
Normal file
5
src/skills/cocktails/vocab/el-gr/Recipie.intent
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
πώς (φτιάχνω|φτιάχνεις) (ένα|το) {drink}
|
||||||
|
πες (μου|μας) πώς να (φτιάξω|φτιάξουμε) (ένα|το) {drink}
|
||||||
|
δώσε (μου|μας) οδηγίες για (ένα|το) {drink}
|
||||||
|
πώς να (φτιάξω) (ένα|το) {drink}
|
||||||
|
ποια είναι η συνταγή για (ένα|το) {drink}
|
2
src/skills/cocktails/vocab/el-gr/TellMe.voc
Normal file
2
src/skills/cocktails/vocab/el-gr/TellMe.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
ποια είναι τα
|
||||||
|
πες μου
|
2
src/skills/cocktails/vocab/el-gr/What.voc
Normal file
2
src/skills/cocktails/vocab/el-gr/What.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
ποιο ήταν
|
||||||
|
ποια ήταν
|
1
src/skills/cocktails/vocab/en-us/Again.voc
Normal file
1
src/skills/cocktails/vocab/en-us/Again.voc
Normal file
@ -0,0 +1 @@
|
|||||||
|
again
|
2
src/skills/cocktails/vocab/en-us/Ingredients.voc
Normal file
2
src/skills/cocktails/vocab/en-us/Ingredients.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
ingredient
|
||||||
|
ingredients
|
3
src/skills/cocktails/vocab/en-us/Needed.intent
Normal file
3
src/skills/cocktails/vocab/en-us/Needed.intent
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
what is needed to make (a|an) {drink}
|
||||||
|
what do (i|you) need (for|to make) (a|an) {drink}
|
||||||
|
what are the (ingredients|ingredient) (of|for) (a|an) {drink}
|
5
src/skills/cocktails/vocab/en-us/Recipie.intent
Normal file
5
src/skills/cocktails/vocab/en-us/Recipie.intent
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
how (would|do) (i|you) (make|mix) (a|an) {drink}
|
||||||
|
tell (me|us) how to (make|mix) (a|an) {drink}
|
||||||
|
give (me|us) instructions for (a|an) {drink}
|
||||||
|
how to (make|mix) (a|an) {drink}
|
||||||
|
what is the recipie for (a|an) {drink}
|
2
src/skills/cocktails/vocab/en-us/TellMe.voc
Normal file
2
src/skills/cocktails/vocab/en-us/TellMe.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
what are
|
||||||
|
tell me
|
2
src/skills/cocktails/vocab/en-us/What.voc
Normal file
2
src/skills/cocktails/vocab/en-us/What.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
what was
|
||||||
|
what were
|
1
src/skills/cocktails/vocab/es-es/Again.voc
Normal file
1
src/skills/cocktails/vocab/es-es/Again.voc
Normal file
@ -0,0 +1 @@
|
|||||||
|
otra vez
|
2
src/skills/cocktails/vocab/es-es/Ingredients.voc
Normal file
2
src/skills/cocktails/vocab/es-es/Ingredients.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
ingrediente
|
||||||
|
ingredientes
|
3
src/skills/cocktails/vocab/es-es/Needed.intent
Normal file
3
src/skills/cocktails/vocab/es-es/Needed.intent
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
qué se necesita para hacer un {drink}
|
||||||
|
qué (hace falta|necesito|necesitas) para hacer un {drink}
|
||||||
|
(cuáles son los ingredientes|cuál es el ingreditente) (de|para hacer) un {drink}
|
5
src/skills/cocktails/vocab/es-es/Recipie.intent
Normal file
5
src/skills/cocktails/vocab/es-es/Recipie.intent
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
cómo (hago|haría|haces|harias) para (hacer|preparar) (un|una) {drink}
|
||||||
|
(cuéntame|dime|dinos|cuéntanos) como (hacer|preparar) (un|una) {drink}
|
||||||
|
(dame|dinos|danos) (las|) instrucciones para (hacer|preparar|) (un|una) {drink}
|
||||||
|
cómo (hacer|preparar|mezclar) (un|una) {drink}
|
||||||
|
cuál es la receta (de|para) (un|una) {drink}
|
2
src/skills/cocktails/vocab/es-es/TellMe.voc
Normal file
2
src/skills/cocktails/vocab/es-es/TellMe.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
cuáles son
|
||||||
|
dime
|
2
src/skills/cocktails/vocab/es-es/What.voc
Normal file
2
src/skills/cocktails/vocab/es-es/What.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
cuál era
|
||||||
|
cuáles eran
|
1
src/skills/cocktails/vocab/fr-fr/Again.voc
Normal file
1
src/skills/cocktails/vocab/fr-fr/Again.voc
Normal file
@ -0,0 +1 @@
|
|||||||
|
encore
|
2
src/skills/cocktails/vocab/fr-fr/Ingredients.voc
Normal file
2
src/skills/cocktails/vocab/fr-fr/Ingredients.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
ingrédient
|
||||||
|
ingrédients
|
3
src/skills/cocktails/vocab/fr-fr/Needed.intent
Normal file
3
src/skills/cocktails/vocab/fr-fr/Needed.intent
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
De quoi a-t-on besoin pour faire (un|une) {drink}
|
||||||
|
De quoi (j'aurai|tu auras) besoin (pour|pour faire) (un|une) {drink}
|
||||||
|
Quels sont les (ingrédients|ingrédient) (d'|pour) (un|une) {drink}
|
5
src/skills/cocktails/vocab/fr-fr/Recipie.intent
Normal file
5
src/skills/cocktails/vocab/fr-fr/Recipie.intent
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
Comment dois (je|tu) (faire|préparer) (un|une) {drink}
|
||||||
|
dis (moi|nous) comment (faire|préparer) (un|une) {drink}
|
||||||
|
donne (moi|nous) les instructions pour (un|une) {drink}
|
||||||
|
comment (faire|préparer) (un|une) {drink}
|
||||||
|
Quelle est la recette pour (un|une) {drink}
|
2
src/skills/cocktails/vocab/fr-fr/TellMe.voc
Normal file
2
src/skills/cocktails/vocab/fr-fr/TellMe.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
quels sont
|
||||||
|
dis moi
|
2
src/skills/cocktails/vocab/fr-fr/What.voc
Normal file
2
src/skills/cocktails/vocab/fr-fr/What.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
quel était
|
||||||
|
qu'est ce qui était
|
1
src/skills/cocktails/vocab/it-it/Again.voc
Normal file
1
src/skills/cocktails/vocab/it-it/Again.voc
Normal file
@ -0,0 +1 @@
|
|||||||
|
di nuovo
|
2
src/skills/cocktails/vocab/it-it/Ingredients.voc
Normal file
2
src/skills/cocktails/vocab/it-it/Ingredients.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
ingrediente
|
||||||
|
ingredienti
|
3
src/skills/cocktails/vocab/it-it/Needed.intent
Normal file
3
src/skills/cocktails/vocab/it-it/Needed.intent
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
che cosa server per fare (un|una) {drink}
|
||||||
|
che cosa (mi|) serve (per|per fare) (un|una) {drink}
|
||||||
|
quali sono gli ingredienti del {drink}
|
5
src/skills/cocktails/vocab/it-it/Recipie.intent
Normal file
5
src/skills/cocktails/vocab/it-it/Recipie.intent
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
come (io|tu) (potrei|fare) (fare|mescolare) (un|uno) {drink}
|
||||||
|
dimmi come (fare|preparare) (un|uno) {drink}
|
||||||
|
dammi istruzioni per (un|uno) {drink}
|
||||||
|
come (fare|mixare) (un|uno) {drink}
|
||||||
|
qual'è la ricetta per (un|uno) {drink}
|
2
src/skills/cocktails/vocab/it-it/TellMe.voc
Normal file
2
src/skills/cocktails/vocab/it-it/TellMe.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
quali sono
|
||||||
|
dimmi
|
2
src/skills/cocktails/vocab/it-it/What.voc
Normal file
2
src/skills/cocktails/vocab/it-it/What.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
qual era
|
||||||
|
quali erano
|
1
src/skills/cocktails/vocab/nl-nl/Again.voc
Normal file
1
src/skills/cocktails/vocab/nl-nl/Again.voc
Normal file
@ -0,0 +1 @@
|
|||||||
|
opnieuw
|
2
src/skills/cocktails/vocab/nl-nl/Ingredients.voc
Normal file
2
src/skills/cocktails/vocab/nl-nl/Ingredients.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
ingrediënt
|
||||||
|
ingrediënten
|
3
src/skills/cocktails/vocab/nl-nl/Needed.intent
Normal file
3
src/skills/cocktails/vocab/nl-nl/Needed.intent
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
wat is nodig om een {drink} te maken
|
||||||
|
wat heb (ik|je) nodig (voor|om) een {drink} (te maken)?
|
||||||
|
wat (zijn de|is het) (ingredienten|ingredient) (van|voor) een {drink}
|
5
src/skills/cocktails/vocab/nl-nl/Recipie.intent
Normal file
5
src/skills/cocktails/vocab/nl-nl/Recipie.intent
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
hoe moet (ik|je) een {drink} (maken|mixen)
|
||||||
|
vertel (me|ons) hoe je een {drink} (maakt|mixt)
|
||||||
|
geef (mij |ons) instructies voor (een | ) {drink}
|
||||||
|
hoe (maak |mix) je (een | ) {drink}
|
||||||
|
wat is het recept voor (een | ) {drink}
|
2
src/skills/cocktails/vocab/nl-nl/TellMe.voc
Normal file
2
src/skills/cocktails/vocab/nl-nl/TellMe.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
wat zijn
|
||||||
|
vertel me
|
2
src/skills/cocktails/vocab/nl-nl/What.voc
Normal file
2
src/skills/cocktails/vocab/nl-nl/What.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
wat was
|
||||||
|
wat waren
|
1
src/skills/cocktails/vocab/pt-br/Again.voc
Normal file
1
src/skills/cocktails/vocab/pt-br/Again.voc
Normal file
@ -0,0 +1 @@
|
|||||||
|
de novo
|
2
src/skills/cocktails/vocab/pt-br/Ingredients.voc
Normal file
2
src/skills/cocktails/vocab/pt-br/Ingredients.voc
Normal file
@ -0,0 +1,2 @@
|
|||||||
|
ingrediente
|
||||||
|
ingredientes
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user