Compare commits
2 Commits
main
...
client-sid
| Author | SHA1 | Date | |
|---|---|---|---|
| b8e65edccd | |||
| a4809fa95a |
3
.env.dev
3
.env.dev
@ -1,3 +0,0 @@
|
|||||||
DEBUG=1
|
|
||||||
SECRET_KEY=foo
|
|
||||||
DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1]
|
|
||||||
@ -1,2 +0,0 @@
|
|||||||
SECRET_KEY=change_me
|
|
||||||
DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1]
|
|
||||||
9
.gitignore
vendored
9
.gitignore
vendored
@ -1,9 +0,0 @@
|
|||||||
*.log
|
|
||||||
*.pot
|
|
||||||
*.pyc
|
|
||||||
__pycache__
|
|
||||||
db.sqlite3
|
|
||||||
media
|
|
||||||
uploads/
|
|
||||||
staticfiles/
|
|
||||||
.env.prod
|
|
||||||
614
LICENSE.md
614
LICENSE.md
@ -1,614 +0,0 @@
|
|||||||
# GNU AFFERO GENERAL PUBLIC LICENSE
|
|
||||||
|
|
||||||
Version 3, 19 November 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 Affero General Public License is a free, copyleft license for
|
|
||||||
software and other kinds of works, specifically designed to ensure
|
|
||||||
cooperation with the community in the case of network server software.
|
|
||||||
|
|
||||||
The licenses for most software and other practical works are designed
|
|
||||||
to take away your freedom to share and change the works. By contrast,
|
|
||||||
our General Public Licenses are intended to guarantee your freedom to
|
|
||||||
share and change all versions of a program--to make sure it remains
|
|
||||||
free software for all its users.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
Developers that use our General Public Licenses protect your rights
|
|
||||||
with two steps: (1) assert copyright on the software, and (2) offer
|
|
||||||
you this License which gives you legal permission to copy, distribute
|
|
||||||
and/or modify the software.
|
|
||||||
|
|
||||||
A secondary benefit of defending all users' freedom is that
|
|
||||||
improvements made in alternate versions of the program, if they
|
|
||||||
receive widespread use, become available for other developers to
|
|
||||||
incorporate. Many developers of free software are heartened and
|
|
||||||
encouraged by the resulting cooperation. However, in the case of
|
|
||||||
software used on network servers, this result may fail to come about.
|
|
||||||
The GNU General Public License permits making a modified version and
|
|
||||||
letting the public access it on a server without ever releasing its
|
|
||||||
source code to the public.
|
|
||||||
|
|
||||||
The GNU Affero General Public License is designed specifically to
|
|
||||||
ensure that, in such cases, the modified source code becomes available
|
|
||||||
to the community. It requires the operator of a network server to
|
|
||||||
provide the source code of the modified version running there to the
|
|
||||||
users of that server. Therefore, public use of a modified version, on
|
|
||||||
a publicly accessible server, gives the public access to the source
|
|
||||||
code of the modified version.
|
|
||||||
|
|
||||||
An older license, called the Affero General Public License and
|
|
||||||
published by Affero, was designed to accomplish similar goals. This is
|
|
||||||
a different license, not a version of the Affero GPL, but Affero has
|
|
||||||
released a new version of the Affero GPL which permits relicensing
|
|
||||||
under this license.
|
|
||||||
|
|
||||||
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 Affero 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. Remote Network Interaction; Use with the GNU General Public License.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, if you modify the
|
|
||||||
Program, your modified version must prominently offer all users
|
|
||||||
interacting with it remotely through a computer network (if your
|
|
||||||
version supports such interaction) an opportunity to receive the
|
|
||||||
Corresponding Source of your version by providing access to the
|
|
||||||
Corresponding Source from a network server at no charge, through some
|
|
||||||
standard or customary means of facilitating copying of software. This
|
|
||||||
Corresponding Source shall include the Corresponding Source for any
|
|
||||||
work covered by version 3 of the GNU General Public License that is
|
|
||||||
incorporated pursuant to the following paragraph.
|
|
||||||
|
|
||||||
Notwithstanding any other provision of this License, you have
|
|
||||||
permission to link or combine any covered work with a work licensed
|
|
||||||
under version 3 of the GNU General Public License into a single
|
|
||||||
combined work, and to convey the resulting work. The terms of this
|
|
||||||
License will continue to apply to the part which is the covered work,
|
|
||||||
but the work with which it is combined will remain governed by version
|
|
||||||
3 of the GNU General Public License.
|
|
||||||
|
|
||||||
### 14. Revised Versions of this License.
|
|
||||||
|
|
||||||
The Free Software Foundation may publish revised and/or new versions
|
|
||||||
of the GNU Affero General Public License from time to time. Such new
|
|
||||||
versions will be similar in spirit to the present version, but may
|
|
||||||
differ in detail to address new problems or concerns.
|
|
||||||
|
|
||||||
Each version is given a distinguishing version number. If the Program
|
|
||||||
specifies that a certain numbered version of the GNU Affero General
|
|
||||||
Public License "or any later version" applies to it, you have the
|
|
||||||
option of following the terms and conditions either of that numbered
|
|
||||||
version or of any later version published by the Free Software
|
|
||||||
Foundation. If the Program does not specify a version number of the
|
|
||||||
GNU Affero General Public License, you may choose any version ever
|
|
||||||
published by the Free Software Foundation.
|
|
||||||
|
|
||||||
If the Program specifies that a proxy can decide which future versions
|
|
||||||
of the GNU Affero General Public License can be used, that proxy's
|
|
||||||
public statement of acceptance of a version permanently authorizes you
|
|
||||||
to choose that version for the Program.
|
|
||||||
|
|
||||||
Later license versions may give you additional or different
|
|
||||||
permissions. However, no additional obligations are imposed on any
|
|
||||||
author or copyright holder as a result of your choosing to follow a
|
|
||||||
later version.
|
|
||||||
|
|
||||||
### 15. Disclaimer of Warranty.
|
|
||||||
|
|
||||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
|
||||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
|
||||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT
|
|
||||||
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
|
|
||||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
||||||
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
|
|
||||||
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
|
|
||||||
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
|
|
||||||
CORRECTION.
|
|
||||||
|
|
||||||
### 16. Limitation of Liability.
|
|
||||||
|
|
||||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
|
||||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
|
|
||||||
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
|
||||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
|
|
||||||
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
|
|
||||||
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
|
|
||||||
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
|
|
||||||
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
|
|
||||||
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
|
||||||
|
|
||||||
### 17. Interpretation of Sections 15 and 16.
|
|
||||||
|
|
||||||
If the disclaimer of warranty and limitation of liability provided
|
|
||||||
above cannot be given local legal effect according to their terms,
|
|
||||||
reviewing courts shall apply local law that most closely approximates
|
|
||||||
an absolute waiver of all civil liability in connection with the
|
|
||||||
Program, unless a warranty or assumption of liability accompanies a
|
|
||||||
copy of the Program in return for a fee.
|
|
||||||
19
Makefile
19
Makefile
@ -1,19 +0,0 @@
|
|||||||
prod: # execute this target on the production server in the nix-shell
|
|
||||||
cd franklincce; yes yes | python3 manage.py collectstatic
|
|
||||||
sh gen_kb.sh
|
|
||||||
sed "s|change_me|$(shell dd if=/dev/urandom bs=1024 count=1|base64)|g" .env.prod.orig > .env.prod
|
|
||||||
docker-compose -f docker-compose.prod.yml up -d --build
|
|
||||||
|
|
||||||
permissions: db.sqlite3
|
|
||||||
chmod -f 660 db.sqlite3
|
|
||||||
echo "make sure that db.sqlite3 is owned by group users"
|
|
||||||
|
|
||||||
db.sqlite3:
|
|
||||||
touch db.sqlite3
|
|
||||||
|
|
||||||
make_kb:
|
|
||||||
sh gen_kb.sh
|
|
||||||
|
|
||||||
clean:
|
|
||||||
rm -fr franklincce/staticfiles
|
|
||||||
docker-compose -f docker-compose.prod.yml down -v
|
|
||||||
4
README
Normal file
4
README
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
yig
|
||||||
|
---
|
||||||
|
|
||||||
|
This is a parser for YMCA CCE YIG/MUN handbooks.
|
||||||
49
README.md
49
README.md
@ -1,49 +0,0 @@
|
|||||||
yig
|
|
||||||
===
|
|
||||||
|
|
||||||
`yig` is a django app for exploring bills and resolutions in previous YMCA CCE conferences.
|
|
||||||
It's sort of ballooned to also contain a knowledge-base thing.
|
|
||||||
|
|
||||||
## Deploying in production
|
|
||||||
|
|
||||||
0. Ensure that you have Docker installed and good to go.
|
|
||||||
|
|
||||||
For NixOS machines, this involves the following:
|
|
||||||
```nix
|
|
||||||
{ ... }
|
|
||||||
{
|
|
||||||
virtualisation.docker.enable = true;
|
|
||||||
users.users.<your user>.extraGroups = [ ... ] ++ [ "docker" ];
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Enter the `nix-shell`.
|
|
||||||
2. `make permissions`
|
|
||||||
3. `make`
|
|
||||||
|
|
||||||
To tear down the docker container, type `make clean`.
|
|
||||||
|
|
||||||
If you've just started the instance, you also need to configure a superuser.
|
|
||||||
|
|
||||||
1. Run `docker ps | grep yig-web | awk -F' ' '{print $1}'` to get the container id
|
|
||||||
2. Run `docker exec -it <container-id> bash` to get a shell.
|
|
||||||
3. Run `python3 manage.py createsuperuser` and follow the prompts.
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
In order to use the `explorer` component of this package, you need to add some legislative texts.
|
|
||||||
These are in the form of PDFs -- they come from the YMCA CCE website or are sometimes emailed or otherwise shared with you.
|
|
||||||
Only these PDFs will work because they follow a very specific format which the software exploits.
|
|
||||||
|
|
||||||
1. Login with your admin account.
|
|
||||||
2. Click on the `add` button next to `Legislation books` in the sidebar
|
|
||||||
3. Upload your book, add a name, and choose the correct `Import strategy`
|
|
||||||
4. Click save
|
|
||||||
|
|
||||||
## More information
|
|
||||||
|
|
||||||
More information about operation of this project can be found in the [knowledgebase](./kb) directory.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
`yig` is licensed under the AGPLv3 -- the terms of the license are available in [`LICENSE.md`](./LICENSE.md).
|
|
||||||
Binary file not shown.
Binary file not shown.
@ -1,15 +0,0 @@
|
|||||||
{ lib, config, pkgs, ... }:
|
|
||||||
{
|
|
||||||
# nix expressions to configure the relevant things
|
|
||||||
# manual nix-shell -c "make clean && make" (etc) is still needed, sadly
|
|
||||||
|
|
||||||
virtualisation.docker.enable = true;
|
|
||||||
|
|
||||||
services.nginx.virtualHosts."franklincce.beepboop.systems" = {
|
|
||||||
forceSSL = true;
|
|
||||||
enableACME = true;
|
|
||||||
locations."/" = {
|
|
||||||
proxyPass = "http://localhost:1337";
|
|
||||||
};
|
|
||||||
};
|
|
||||||
}
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
services:
|
|
||||||
web:
|
|
||||||
build:
|
|
||||||
context: ./franklincce
|
|
||||||
dockerfile: Dockerfile.prod
|
|
||||||
command: gunicorn franklincce.wsgi:application --bind 0.0.0.0:8000
|
|
||||||
volumes:
|
|
||||||
- type: volume
|
|
||||||
source: static_volume
|
|
||||||
target: /home/app/web/staticfiles
|
|
||||||
- type: bind
|
|
||||||
source: ./db.sqlite3
|
|
||||||
target: /home/app/web/db.sqlite3
|
|
||||||
expose:
|
|
||||||
- 8000
|
|
||||||
env_file:
|
|
||||||
- ./.env.prod
|
|
||||||
nginx:
|
|
||||||
build: ./nginx
|
|
||||||
volumes:
|
|
||||||
- static_volume:/home/app/web/staticfiles
|
|
||||||
ports:
|
|
||||||
- 1337:80
|
|
||||||
depends_on:
|
|
||||||
- web
|
|
||||||
volumes:
|
|
||||||
static_volume:
|
|
||||||
@ -1,10 +0,0 @@
|
|||||||
services:
|
|
||||||
web:
|
|
||||||
build: ./franklincce
|
|
||||||
command: python manage.py runserver 0.0.0.0:8000
|
|
||||||
volumes:
|
|
||||||
- ./franklincce/:/usr/src/app/
|
|
||||||
ports:
|
|
||||||
- 8000:8000
|
|
||||||
env_file:
|
|
||||||
- ./.env.dev
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
# pull official base image
|
|
||||||
FROM python:3.11.4-slim-buster
|
|
||||||
|
|
||||||
# set work directory
|
|
||||||
WORKDIR /usr/src/app
|
|
||||||
|
|
||||||
# set environment variables
|
|
||||||
ENV PYTHONDONTWRITEBYTECODE 1
|
|
||||||
ENV PYTHONUNBUFFERED 1
|
|
||||||
|
|
||||||
# install dependencies
|
|
||||||
RUN pip install --upgrade pip
|
|
||||||
COPY ./requirements.txt .
|
|
||||||
RUN pip install -r requirements.txt
|
|
||||||
|
|
||||||
# copy project
|
|
||||||
COPY . .
|
|
||||||
@ -1,56 +0,0 @@
|
|||||||
FROM python:3.11.4-slim-buster as builder
|
|
||||||
|
|
||||||
# set work directory
|
|
||||||
WORKDIR /usr/src/app
|
|
||||||
|
|
||||||
# set environment variables
|
|
||||||
ENV PYTHONDONTWRITEBYTECODE 1
|
|
||||||
ENV PYTHONUNBUFFERED 1
|
|
||||||
|
|
||||||
# install system dependencies
|
|
||||||
RUN apt-get update && \
|
|
||||||
apt-get install -y --no-install-recommends gcc
|
|
||||||
|
|
||||||
COPY ./requirements.txt .
|
|
||||||
RUN pip wheel --no-cache-dir --no-deps --wheel-dir /usr/src/app/wheels -r requirements.txt
|
|
||||||
|
|
||||||
# pull official base image
|
|
||||||
FROM python:3.11.4-slim-buster
|
|
||||||
|
|
||||||
# create directory for the app user
|
|
||||||
RUN mkdir -p /home/app
|
|
||||||
|
|
||||||
# create the app user
|
|
||||||
RUN addgroup --system app && adduser --system --group app
|
|
||||||
RUN usermod -a -G users app
|
|
||||||
|
|
||||||
# create the appropriate directories
|
|
||||||
ENV HOME=/home/app
|
|
||||||
ENV APP_HOME=/home/app/web
|
|
||||||
RUN mkdir $APP_HOME
|
|
||||||
RUN mkdir $APP_HOME/staticfiles
|
|
||||||
WORKDIR $APP_HOME
|
|
||||||
|
|
||||||
# install dependencies
|
|
||||||
RUN apt-get update && apt-get install -y --no-install-recommends netcat
|
|
||||||
COPY --from=builder /usr/src/app/wheels /wheels
|
|
||||||
COPY --from=builder /usr/src/app/requirements.txt .
|
|
||||||
RUN pip install --upgrade pip
|
|
||||||
RUN pip install --no-cache /wheels/*
|
|
||||||
|
|
||||||
# copy entrypoint.prod.sh
|
|
||||||
COPY ./entrypoint.prod.sh .
|
|
||||||
RUN sed -i 's/\r$//g' $APP_HOME/entrypoint.prod.sh
|
|
||||||
RUN chmod +x $APP_HOME/entrypoint.prod.sh
|
|
||||||
|
|
||||||
# copy project
|
|
||||||
COPY . $APP_HOME
|
|
||||||
|
|
||||||
# chown all the files to the app user
|
|
||||||
RUN chown -R app:app $APP_HOME
|
|
||||||
|
|
||||||
# change to the app user
|
|
||||||
USER app
|
|
||||||
|
|
||||||
# run entrypoint.prod.sh
|
|
||||||
ENTRYPOINT ["/home/app/web/entrypoint.prod.sh"]
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
|
|
||||||
python3 manage.py makemigrations
|
|
||||||
python3 manage.py migrate --run-syncdb
|
|
||||||
|
|
||||||
exec "$@"
|
|
||||||
@ -1,21 +0,0 @@
|
|||||||
from django.contrib import admin
|
|
||||||
|
|
||||||
from explorer import models
|
|
||||||
|
|
||||||
class LegislativeTextAdmin(admin.ModelAdmin):
|
|
||||||
list_display = ('__str__', 'legislation_title', 'school')
|
|
||||||
|
|
||||||
class LegislationBookAdmin(admin.ModelAdmin):
|
|
||||||
exclude = ("has_performed_export",)
|
|
||||||
|
|
||||||
to_register = [
|
|
||||||
[models.LegislativeText, LegislativeTextAdmin],
|
|
||||||
[models.LegislationBook, LegislationBookAdmin],
|
|
||||||
[models.LegislationClassification],
|
|
||||||
[models.School],
|
|
||||||
[models.Country],
|
|
||||||
[models.Sponsor],
|
|
||||||
[models.Category],
|
|
||||||
]
|
|
||||||
for i in to_register:
|
|
||||||
admin.site.register(*i)
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
from django.apps import AppConfig
|
|
||||||
|
|
||||||
|
|
||||||
class ExplorerConfig(AppConfig):
|
|
||||||
default_auto_field = 'django.db.models.BigAutoField'
|
|
||||||
name = 'explorer'
|
|
||||||
@ -1,327 +0,0 @@
|
|||||||
from typing import Any, ClassVar
|
|
||||||
from dataclasses import dataclass
|
|
||||||
|
|
||||||
import fitz
|
|
||||||
|
|
||||||
class FitzBlockWrapper:
|
|
||||||
def __init__(self, block):
|
|
||||||
self.x0, self.y0, self.x1, \
|
|
||||||
self.y1, self.text, \
|
|
||||||
self.block_number, self.block_type = block
|
|
||||||
|
|
||||||
self.x0 = int(self.x0)
|
|
||||||
self.x1 = int(self.x1)
|
|
||||||
self.y0 = int(self.y0)
|
|
||||||
self.y1 = int(self.y1)
|
|
||||||
self.block_number = int(self.block_number)
|
|
||||||
self.block_type = int(self.block_type)
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
return str((
|
|
||||||
self.x0, self.y0, self.x1, self.y1, self.text
|
|
||||||
))
|
|
||||||
|
|
||||||
def __repl__(self):
|
|
||||||
return self.__str__()
|
|
||||||
|
|
||||||
def words_in_superstring(words: list[str], superstring: str) -> bool:
|
|
||||||
for word in words:
|
|
||||||
if not str(word).lower() in str(superstring).lower():
|
|
||||||
return False
|
|
||||||
return True
|
|
||||||
|
|
||||||
def split_by_lambda(arr: list[Any], func):
|
|
||||||
output = []
|
|
||||||
current = []
|
|
||||||
for item in arr:
|
|
||||||
if func(item):
|
|
||||||
output.append(current)
|
|
||||||
current = []
|
|
||||||
else:
|
|
||||||
current.append(item)
|
|
||||||
|
|
||||||
output.append(current)
|
|
||||||
return output
|
|
||||||
|
|
||||||
def get_block_by_x_value(arr: list[FitzBlockWrapper], xvalue: int) -> FitzBlockWrapper:
|
|
||||||
for item in arr:
|
|
||||||
if item.x0 == xvalue:
|
|
||||||
return item
|
|
||||||
|
|
||||||
def remove_block_by_x_value(arr: list[FitzBlockWrapper], xvalue: int) -> list[FitzBlockWrapper]:
|
|
||||||
return [i for i in arr if not i.x0 == xvalue]
|
|
||||||
|
|
||||||
class CCEParserBase():
|
|
||||||
section_page_words: ClassVar[list[str]]
|
|
||||||
last_page_words: ClassVar[list[str]]
|
|
||||||
split_leg_pages_needle: ClassVar[str]
|
|
||||||
|
|
||||||
def __init__(self, document: fitz.Document):
|
|
||||||
self.document = document
|
|
||||||
self.__post_init__()
|
|
||||||
|
|
||||||
def __post_init__(self):
|
|
||||||
# run all the processing steps here
|
|
||||||
self.parse_legislative_metablocks()
|
|
||||||
|
|
||||||
def generate_section_markers(self) -> list[int]:
|
|
||||||
"""
|
|
||||||
In the YIG/MUN manuals, there's section markers that delineate between the different
|
|
||||||
committees within the manual. Let's find those, and then the last legislative page.
|
|
||||||
"""
|
|
||||||
section_pages = []
|
|
||||||
|
|
||||||
for page in self.document:
|
|
||||||
text = page.get_text().encode("utf8")
|
|
||||||
is_section_page = words_in_superstring(
|
|
||||||
words = self.section_page_words,
|
|
||||||
superstring = text
|
|
||||||
)
|
|
||||||
is_last_page = words_in_superstring(
|
|
||||||
words = self.last_page_words,
|
|
||||||
superstring = text
|
|
||||||
)
|
|
||||||
|
|
||||||
if is_section_page:
|
|
||||||
section_pages.append(page.number)
|
|
||||||
|
|
||||||
if is_last_page and len(section_pages) > 2:
|
|
||||||
section_pages.append(page.number)
|
|
||||||
|
|
||||||
return section_pages
|
|
||||||
|
|
||||||
def get_legislative_pages(self):
|
|
||||||
"""
|
|
||||||
Generate the section markers, then fill in the pages between them.
|
|
||||||
"""
|
|
||||||
|
|
||||||
current = 0
|
|
||||||
sections = self.generate_section_markers()
|
|
||||||
legislative_pages: list[int] = []
|
|
||||||
try:
|
|
||||||
while True:
|
|
||||||
legislative_pages += list(
|
|
||||||
range(
|
|
||||||
sections[current] + 1,
|
|
||||||
sections[current + 1],
|
|
||||||
1
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
current += 1
|
|
||||||
|
|
||||||
except IndexError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
|
|
||||||
return legislative_pages
|
|
||||||
|
|
||||||
def concat_blocks_for_leg_pages(self):
|
|
||||||
"""
|
|
||||||
From the legislative pages, concatenate the "blocks" of text in the PDF.
|
|
||||||
"""
|
|
||||||
blocks = []
|
|
||||||
pages = [self.document.load_page(page_num) for page_num in self.get_legislative_pages()]
|
|
||||||
for page in pages:
|
|
||||||
block_info = [FitzBlockWrapper(block) for block in page.get_text("blocks")]
|
|
||||||
|
|
||||||
blocks += block_info
|
|
||||||
|
|
||||||
return blocks
|
|
||||||
|
|
||||||
def split_leg_pages(self):
|
|
||||||
"""
|
|
||||||
We have the collection of legislative page text blocks. We need
|
|
||||||
to split them now. We split on the text "71st General Assembly...
|
|
||||||
Youth in Government"
|
|
||||||
"""
|
|
||||||
|
|
||||||
blocks = self.concat_blocks_for_leg_pages()
|
|
||||||
# each item within splitted is called a "legislative meta-block"
|
|
||||||
splitted = split_by_lambda(blocks, lambda x: self.split_leg_pages_needle in x.text)
|
|
||||||
|
|
||||||
return splitted[1:] # there's an empty array at the beginning
|
|
||||||
|
|
||||||
def handle_the_rest(self, the_rest):
|
|
||||||
weird_character = u''
|
|
||||||
another_weird_character = u'\uFFFd'
|
|
||||||
splitted_by_weird = the_rest.replace(weird_character, another_weird_character).split(another_weird_character)
|
|
||||||
title_content = ''.join(
|
|
||||||
splitted_by_weird[0].split('\n')[:-1]
|
|
||||||
).rstrip().lstrip()
|
|
||||||
|
|
||||||
bill_text = [i.split('\n')[0][1:] for i in splitted_by_weird[1:]]
|
|
||||||
|
|
||||||
return {
|
|
||||||
"bill_text": '\n'.join(bill_text),
|
|
||||||
"title": title_content
|
|
||||||
}
|
|
||||||
|
|
||||||
def parse_legislative_metablocks(self):
|
|
||||||
output = []
|
|
||||||
splitted = self.split_leg_pages()
|
|
||||||
for legislative_text in splitted:
|
|
||||||
# there are some blocks that contain just one value
|
|
||||||
# and are aligned to some x value on the pdf
|
|
||||||
# it's an easy way to extract stuff
|
|
||||||
|
|
||||||
try:
|
|
||||||
country = get_block_by_x_value(legislative_text, 139).text.rstrip()
|
|
||||||
country = country.replace("Sponsor: ", "").lstrip()
|
|
||||||
except AttributeError:
|
|
||||||
country = None # this is a yig bill
|
|
||||||
|
|
||||||
try:
|
|
||||||
category = get_block_by_x_value(legislative_text, 151).text.rstrip().lstrip()
|
|
||||||
except AttributeError:
|
|
||||||
try:
|
|
||||||
category = get_block_by_x_value(legislative_text, 153).text.rstrip().lstrip()
|
|
||||||
except AttributeError:
|
|
||||||
print([(i.text, i.x0) for i in legislative_text])
|
|
||||||
|
|
||||||
leg_code = get_block_by_x_value(legislative_text, 88).text.rstrip()
|
|
||||||
|
|
||||||
try:
|
|
||||||
school = get_block_by_x_value(legislative_text, 177).text.rstrip().lstrip()
|
|
||||||
except AttributeError:
|
|
||||||
try:
|
|
||||||
school = get_block_by_x_value(legislative_text, 186).text.rstrip().lstrip()
|
|
||||||
except AttributeError:
|
|
||||||
school = "you tell me, man"
|
|
||||||
|
|
||||||
try:
|
|
||||||
sponsors = get_block_by_x_value(legislative_text, 163).text.rstrip().lstrip()
|
|
||||||
except AttributeError:
|
|
||||||
try:
|
|
||||||
sponsors = get_block_by_x_value(legislative_text, 166).text.rstrip().lstrip()
|
|
||||||
except AttributeError:
|
|
||||||
sponsors = "you tell me, man"
|
|
||||||
|
|
||||||
the_rest = ''.join([i.text for i in legislative_text[12:]])
|
|
||||||
handled = self.handle_the_rest(the_rest)
|
|
||||||
title = handled["title"]
|
|
||||||
bill_text = handled["bill_text"]
|
|
||||||
|
|
||||||
codesplit = leg_code.split('/')
|
|
||||||
assembly = codesplit[0]
|
|
||||||
dashsplit = codesplit[1].split('-')
|
|
||||||
year = 2000 + int(dashsplit[0])
|
|
||||||
committee = int(dashsplit[1])
|
|
||||||
docket_order = int(dashsplit[2])
|
|
||||||
|
|
||||||
output.append({
|
|
||||||
"assembly": assembly,
|
|
||||||
"year": year,
|
|
||||||
"committee": committee,
|
|
||||||
"docket_order": docket_order,
|
|
||||||
"category": category,
|
|
||||||
"country": country,
|
|
||||||
"school": school,
|
|
||||||
"sponsors": sponsors,
|
|
||||||
"legislation_title": title,
|
|
||||||
"text": bill_text
|
|
||||||
})
|
|
||||||
|
|
||||||
self.output = output
|
|
||||||
|
|
||||||
|
|
||||||
class HSMUN23(CCEParserBase):
|
|
||||||
section_page_words = ["Committee", "Model", "United", "YMCA", "Tennessee", "Nations"]
|
|
||||||
last_page_words = ["ABCs"]
|
|
||||||
split_leg_pages_needle = "43rd General Assembly"
|
|
||||||
|
|
||||||
class HSYIG24(CCEParserBase):
|
|
||||||
section_page_words = [ "Committee", "YMCA", "Tennessee", "Youth", "in" ]
|
|
||||||
last_page_words = [ "ABCs" ]
|
|
||||||
split_leg_pages_needle = "71st General Assembly"
|
|
||||||
|
|
||||||
def generate_section_markers(self) -> list[int]:
|
|
||||||
"""
|
|
||||||
This overrides the regular method because we need to check
|
|
||||||
for three images on a section page
|
|
||||||
"""
|
|
||||||
section_pages = []
|
|
||||||
|
|
||||||
for page in self.document:
|
|
||||||
text = page.get_text().encode("utf8")
|
|
||||||
is_section_page = words_in_superstring(
|
|
||||||
words = self.section_page_words,
|
|
||||||
superstring = text
|
|
||||||
)
|
|
||||||
is_last_page = words_in_superstring(
|
|
||||||
words = self.last_page_words,
|
|
||||||
superstring = text
|
|
||||||
)
|
|
||||||
|
|
||||||
if is_section_page and len(page.get_images()) == 3:
|
|
||||||
section_pages.append(page.number)
|
|
||||||
|
|
||||||
if is_last_page and len(section_pages) > 2:
|
|
||||||
section_pages.append(page.number)
|
|
||||||
|
|
||||||
return section_pages
|
|
||||||
|
|
||||||
def parse_legislative_metablocks(self):
|
|
||||||
"""
|
|
||||||
This is YIG specific code
|
|
||||||
"""
|
|
||||||
output = []
|
|
||||||
splitted = self.split_leg_pages()
|
|
||||||
for legislative_text in splitted:
|
|
||||||
# there are some blocks that contain just one value
|
|
||||||
# and are aligned to some x value on the pdf
|
|
||||||
|
|
||||||
# it's an easy way to extract stuff
|
|
||||||
legislative_text = remove_block_by_x_value(legislative_text, 565) # remove page numbers
|
|
||||||
category = get_block_by_x_value(legislative_text, 139).text.rstrip().lstrip()
|
|
||||||
leg_code = get_block_by_x_value(legislative_text, 88).text.rstrip()
|
|
||||||
school = get_block_by_x_value(legislative_text, 163).text.rstrip().lstrip()
|
|
||||||
sponsors = get_block_by_x_value(legislative_text, 152).text.rstrip().lstrip()
|
|
||||||
the_rest = ''.join([i.text for i in legislative_text[6:]])
|
|
||||||
handled = self.handle_the_rest(the_rest)
|
|
||||||
title = handled["title"]
|
|
||||||
bill_text = handled["bill_text"]
|
|
||||||
|
|
||||||
codesplit = leg_code.split('/')
|
|
||||||
assembly = codesplit[0]
|
|
||||||
dashsplit = codesplit[1].split('-')
|
|
||||||
year = 2000 + int(dashsplit[0])
|
|
||||||
committee = int(dashsplit[1])
|
|
||||||
docket_order = int(dashsplit[2])
|
|
||||||
|
|
||||||
output.append({
|
|
||||||
"assembly": assembly,
|
|
||||||
"year": year,
|
|
||||||
"committee": committee,
|
|
||||||
"docket_order": docket_order,
|
|
||||||
"category": category,
|
|
||||||
"country": None, # this is a yig bill
|
|
||||||
"school": school,
|
|
||||||
"sponsors": sponsors,
|
|
||||||
"legislation_title": title,
|
|
||||||
"text": bill_text
|
|
||||||
})
|
|
||||||
|
|
||||||
self.output = output
|
|
||||||
|
|
||||||
def main():
|
|
||||||
argv = sys.argv
|
|
||||||
doc = fitz.open(argv[1])
|
|
||||||
if argv[2] == "HSYIG":
|
|
||||||
doc = HSYIG24(doc)
|
|
||||||
elif argv[2] == "HSMUN":
|
|
||||||
doc = HSMUN23(doc)
|
|
||||||
else:
|
|
||||||
print("nonvalid book thing")
|
|
||||||
return
|
|
||||||
|
|
||||||
for text in doc.output:
|
|
||||||
print("{} {} {} ---------------------------- {}".format(
|
|
||||||
text["country"], text["category"],
|
|
||||||
text["legislation_title"], text["text"]
|
|
||||||
))
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
import sys
|
|
||||||
|
|
||||||
main()
|
|
||||||
@ -1,87 +0,0 @@
|
|||||||
# Generated by Django 4.2.14 on 2024-07-24 06:38
|
|
||||||
|
|
||||||
from django.db import migrations, models
|
|
||||||
import django.db.models.deletion
|
|
||||||
|
|
||||||
|
|
||||||
class Migration(migrations.Migration):
|
|
||||||
|
|
||||||
initial = True
|
|
||||||
|
|
||||||
dependencies = [
|
|
||||||
]
|
|
||||||
|
|
||||||
operations = [
|
|
||||||
migrations.CreateModel(
|
|
||||||
name='Country',
|
|
||||||
fields=[
|
|
||||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
|
||||||
('name', models.CharField(max_length=256)),
|
|
||||||
],
|
|
||||||
options={
|
|
||||||
'verbose_name_plural': 'Countries',
|
|
||||||
},
|
|
||||||
),
|
|
||||||
migrations.CreateModel(
|
|
||||||
name='LegislationBook',
|
|
||||||
fields=[
|
|
||||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
|
||||||
('conference_type', models.CharField(choices=[('M', 'Middle School'), ('H', 'High School')], default='H', max_length=1)),
|
|
||||||
('pdf', models.FileField(upload_to='uploads/')),
|
|
||||||
('name', models.CharField(max_length=256)),
|
|
||||||
('import_strategy', models.CharField(choices=[('HSYIGBookParser', 'High School YIG Book Parser 1'), ('HSMUNBookParser', 'High School MUN Book Parser 1')], default='HSYIGBookParser', max_length=128)),
|
|
||||||
('has_performed_export', models.BooleanField(default=False)),
|
|
||||||
],
|
|
||||||
options={
|
|
||||||
'verbose_name': 'Book',
|
|
||||||
'verbose_name_plural': 'Books',
|
|
||||||
},
|
|
||||||
),
|
|
||||||
migrations.CreateModel(
|
|
||||||
name='LegislationClassification',
|
|
||||||
fields=[
|
|
||||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
|
||||||
('name', models.CharField(help_text='Name of this classification.', max_length=256)),
|
|
||||||
('text_to_match', models.CharField(help_text='a comma seperated list of keywords to include in the classification. spaces and dashes are discluded.', max_length=256)),
|
|
||||||
],
|
|
||||||
options={
|
|
||||||
'verbose_name': 'Topic',
|
|
||||||
'verbose_name_plural': 'Topics',
|
|
||||||
},
|
|
||||||
),
|
|
||||||
migrations.CreateModel(
|
|
||||||
name='School',
|
|
||||||
fields=[
|
|
||||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
|
||||||
('name', models.CharField(max_length=256)),
|
|
||||||
],
|
|
||||||
),
|
|
||||||
migrations.CreateModel(
|
|
||||||
name='Sponsor',
|
|
||||||
fields=[
|
|
||||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
|
||||||
('name', models.CharField(max_length=256)),
|
|
||||||
],
|
|
||||||
),
|
|
||||||
migrations.CreateModel(
|
|
||||||
name='LegislativeText',
|
|
||||||
fields=[
|
|
||||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
|
||||||
('assembly', models.CharField(choices=[('RGA', 'Red General Assembly'), ('BGA', 'Blue General Assembly'), ('WGA', 'White General Assembly'), ('RHB', 'Red House'), ('BHB', 'Blue House'), ('WHB', 'White House'), ('RSB', 'Red Senate'), ('BSB', 'Blue Senate'), ('WSB', 'White Senate'), ('SEN', 'Senate'), ('HOU', 'House'), ('GEN', 'General Assembly')], default='GEN', max_length=3)),
|
|
||||||
('text', models.TextField()),
|
|
||||||
('year', models.IntegerField()),
|
|
||||||
('committee', models.IntegerField()),
|
|
||||||
('category', models.CharField(max_length=256)),
|
|
||||||
('docket_order', models.IntegerField()),
|
|
||||||
('legislation_title', models.CharField(max_length=512)),
|
|
||||||
('country', models.ForeignKey(null=True, on_delete=django.db.models.deletion.CASCADE, to='explorer.country')),
|
|
||||||
('from_book', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='explorer.legislationbook')),
|
|
||||||
('school', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='explorer.school')),
|
|
||||||
('sponsors', models.ManyToManyField(blank=True, to='explorer.sponsor')),
|
|
||||||
],
|
|
||||||
options={
|
|
||||||
'verbose_name': 'Legislation',
|
|
||||||
'verbose_name_plural': 'Legislation',
|
|
||||||
},
|
|
||||||
),
|
|
||||||
]
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
# Generated by Django 4.2.14 on 2024-07-24 17:58
|
|
||||||
|
|
||||||
from django.db import migrations, models
|
|
||||||
import django.db.models.deletion
|
|
||||||
|
|
||||||
|
|
||||||
class Migration(migrations.Migration):
|
|
||||||
|
|
||||||
dependencies = [
|
|
||||||
('explorer', '0001_initial'),
|
|
||||||
]
|
|
||||||
|
|
||||||
operations = [
|
|
||||||
migrations.CreateModel(
|
|
||||||
name='Category',
|
|
||||||
fields=[
|
|
||||||
('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
|
|
||||||
('name', models.CharField(max_length=256)),
|
|
||||||
],
|
|
||||||
),
|
|
||||||
migrations.AlterField(
|
|
||||||
model_name='legislativetext',
|
|
||||||
name='category',
|
|
||||||
field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='explorer.category'),
|
|
||||||
),
|
|
||||||
]
|
|
||||||
@ -1,234 +0,0 @@
|
|||||||
from django.db import models
|
|
||||||
from django.utils.translation import gettext_lazy as _
|
|
||||||
from django.urls import reverse
|
|
||||||
|
|
||||||
from .leglib import HSYIG24, HSMUN23
|
|
||||||
import io
|
|
||||||
import fitz
|
|
||||||
|
|
||||||
from collections import namedtuple
|
|
||||||
|
|
||||||
def InstantiateIfNone(model, name):
|
|
||||||
"""
|
|
||||||
Search the model for instances by name.
|
|
||||||
If there's none, then create one.
|
|
||||||
"""
|
|
||||||
filtered = model.objects.filter(name__exact=name)
|
|
||||||
try:
|
|
||||||
return filtered[0]
|
|
||||||
except IndexError:
|
|
||||||
obj = model(name=name)
|
|
||||||
obj.save()
|
|
||||||
return obj
|
|
||||||
|
|
||||||
class School(models.Model):
|
|
||||||
name = models.CharField(max_length=256)
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
return self.name
|
|
||||||
|
|
||||||
def get_absolute_url(self):
|
|
||||||
our_name = __class__.__name__
|
|
||||||
return reverse("{}.detail".format(our_name), kwargs={"model_id": self.id})
|
|
||||||
|
|
||||||
class Country(models.Model):
|
|
||||||
name = models.CharField(max_length=256)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
verbose_name_plural = "Countries"
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
return self.name
|
|
||||||
|
|
||||||
def get_absolute_url(self):
|
|
||||||
our_name = __class__.__name__
|
|
||||||
return reverse("{}.detail".format(our_name), kwargs={"model_id": self.id})
|
|
||||||
|
|
||||||
class Sponsor(models.Model):
|
|
||||||
name = models.CharField(max_length=256)
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
return self.name
|
|
||||||
|
|
||||||
def get_absolute_url(self):
|
|
||||||
our_name = __class__.__name__
|
|
||||||
return reverse("{}.detail".format(our_name), kwargs={"model_id": self.id})
|
|
||||||
|
|
||||||
class Category(models.Model):
|
|
||||||
name = models.CharField(max_length=256)
|
|
||||||
|
|
||||||
class Meta:
|
|
||||||
verbose_name_plural = "Categories"
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
return "{}".format(self.name)
|
|
||||||
|
|
||||||
def get_absolute_url(self):
|
|
||||||
our_name = __class__.__name__
|
|
||||||
return reverse("{}.detail".format(our_name), kwargs={"model_id": self.id})
|
|
||||||
|
|
||||||
class LegislationBook(models.Model):
|
|
||||||
class Meta:
|
|
||||||
verbose_name = "Book"
|
|
||||||
verbose_name_plural = "Books"
|
|
||||||
|
|
||||||
class ConferenceType(models.TextChoices):
|
|
||||||
MIDDLE = "M", _("Middle School")
|
|
||||||
HIGH = "H", _("High School")
|
|
||||||
|
|
||||||
class ImportStrategy(models.TextChoices):
|
|
||||||
HSYIGA = "HSYIGBookParser", _("High School YIG Book Parser 1")
|
|
||||||
HSMUNA = "HSMUNBookParser", _("High School MUN Book Parser 1")
|
|
||||||
|
|
||||||
conference_type = models.CharField(
|
|
||||||
max_length=1,
|
|
||||||
choices=ConferenceType.choices,
|
|
||||||
default=ConferenceType.HIGH,
|
|
||||||
)
|
|
||||||
pdf = models.FileField(upload_to="uploads/")
|
|
||||||
name = models.CharField(max_length=256)
|
|
||||||
import_strategy = models.CharField(
|
|
||||||
max_length=128,
|
|
||||||
choices=ImportStrategy.choices,
|
|
||||||
default=ImportStrategy.HSYIGA
|
|
||||||
)
|
|
||||||
has_performed_export = models.BooleanField(default=False)
|
|
||||||
|
|
||||||
def save(self, **kwargs):
|
|
||||||
if not self.has_performed_export:
|
|
||||||
self.has_performed_export = True
|
|
||||||
super().save(**kwargs)
|
|
||||||
else:
|
|
||||||
return
|
|
||||||
|
|
||||||
the_file = io.BytesIO(self.pdf.file.file.read())
|
|
||||||
the_document = fitz.open(stream=the_file)
|
|
||||||
if self.import_strategy == "HSYIGBookParser":
|
|
||||||
parsed = HSYIG24(the_document)
|
|
||||||
elif self.import_strategy == "HSMUNBookParser":
|
|
||||||
parsed = HSMUN23(the_document)
|
|
||||||
else:
|
|
||||||
return
|
|
||||||
|
|
||||||
for text in parsed.output:
|
|
||||||
text["school"] = InstantiateIfNone(School, text["school"])
|
|
||||||
if text["country"]:
|
|
||||||
# there's sometimes "Dominican Republic" and "Dominican Republic 2"
|
|
||||||
# handle that gracefully
|
|
||||||
text["country"] = text["country"].replace(" 2", "")
|
|
||||||
text["country"] = InstantiateIfNone(Country, text["country"])
|
|
||||||
|
|
||||||
if not text["category"] or text["category"] == "Select One--":
|
|
||||||
text["category"] = "No category"
|
|
||||||
text["category"] = InstantiateIfNone(Category, text["category"])
|
|
||||||
|
|
||||||
sponsors = text["sponsors"].split(', ')
|
|
||||||
sponsors = [InstantiateIfNone(Sponsor, sponsor) for sponsor in sponsors]
|
|
||||||
|
|
||||||
del text["sponsors"]
|
|
||||||
|
|
||||||
text = LegislativeText(**text, from_book=self)
|
|
||||||
text.save()
|
|
||||||
|
|
||||||
for sponsor in sponsors:
|
|
||||||
text.sponsors.add(sponsor)
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
return "{}".format(self.name)
|
|
||||||
|
|
||||||
def get_absolute_url(self):
|
|
||||||
our_name = __class__.__name__
|
|
||||||
return reverse("{}.detail".format(our_name), kwargs={"model_id": self.id})
|
|
||||||
|
|
||||||
class LegislativeText(models.Model):
|
|
||||||
class Meta:
|
|
||||||
verbose_name = "Legislation"
|
|
||||||
verbose_name_plural = "Legislation"
|
|
||||||
|
|
||||||
class Assemblies(models.TextChoices):
|
|
||||||
RGA = "RGA", _("Red General Assembly")
|
|
||||||
BGA = "BGA", _("Blue General Assembly")
|
|
||||||
WGA = "WGA", _("White General Assembly")
|
|
||||||
RHB = "RHB", _("Red House")
|
|
||||||
BHB = "BHB", _("Blue House")
|
|
||||||
WHB = "WHB", _("White House")
|
|
||||||
RSB = "RSB", _("Red Senate")
|
|
||||||
BSB = "BSB", _("Blue Senate")
|
|
||||||
WSB = "WSB", _("White Senate")
|
|
||||||
SEN = "SEN", _("Senate")
|
|
||||||
HOU = "HOU", _("House")
|
|
||||||
GEN = "GEN", _("General Assembly")
|
|
||||||
|
|
||||||
assembly = models.CharField(
|
|
||||||
max_length=3,
|
|
||||||
choices=Assemblies.choices,
|
|
||||||
default=Assemblies.GEN
|
|
||||||
)
|
|
||||||
text = models.TextField()
|
|
||||||
year = models.IntegerField()
|
|
||||||
committee = models.IntegerField()
|
|
||||||
category = models.ForeignKey(Category, on_delete=models.CASCADE)
|
|
||||||
docket_order = models.IntegerField()
|
|
||||||
school = models.ForeignKey(School, on_delete=models.CASCADE)
|
|
||||||
sponsors = models.ManyToManyField(Sponsor, blank=True)
|
|
||||||
from_book = models.ForeignKey(LegislationBook, on_delete=models.CASCADE)
|
|
||||||
legislation_title = models.CharField(max_length=512)
|
|
||||||
country = models.ForeignKey(Country, on_delete=models.CASCADE, null=True)
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
return "{}/{}-{}-{}".format(
|
|
||||||
self.assembly,
|
|
||||||
str(self.year),
|
|
||||||
self.committee,
|
|
||||||
self.docket_order,
|
|
||||||
)
|
|
||||||
|
|
||||||
def get_lines(self):
|
|
||||||
cls = namedtuple('LegLine', ['linenumber', 'linetext'])
|
|
||||||
return [cls(i + 1, j) for i, j in enumerate(self.text.split('\n'))]
|
|
||||||
|
|
||||||
def is_bill(self):
|
|
||||||
if self.assembly in [
|
|
||||||
"RHB",
|
|
||||||
"BHB",
|
|
||||||
"WHB",
|
|
||||||
"RSB",
|
|
||||||
"BSB",
|
|
||||||
"WSB",
|
|
||||||
"SEN",
|
|
||||||
"HOU",
|
|
||||||
]:
|
|
||||||
return True
|
|
||||||
return False
|
|
||||||
|
|
||||||
def is_resolution(self):
|
|
||||||
if self.assembly in ["RGA", "BGA", "WGA", "GEN"]:
|
|
||||||
return True
|
|
||||||
return False
|
|
||||||
|
|
||||||
class LegislationClassification(models.Model):
|
|
||||||
class Meta:
|
|
||||||
verbose_name = "Topic"
|
|
||||||
verbose_name_plural = "Topics"
|
|
||||||
|
|
||||||
name = models.CharField(max_length=256, help_text="Name of this classification.")
|
|
||||||
text_to_match = models.CharField(
|
|
||||||
max_length=256,
|
|
||||||
help_text="a comma seperated list of keywords to include in the classification. spaces and dashes are discluded."
|
|
||||||
)
|
|
||||||
|
|
||||||
def __str__(self):
|
|
||||||
return "{}".format(self.name)
|
|
||||||
|
|
||||||
def get_absolute_url(self):
|
|
||||||
our_name = __class__.__name__
|
|
||||||
return reverse("{}.detail".format(our_name), kwargs={"model_id": self.id})
|
|
||||||
|
|
||||||
models_in_index = [
|
|
||||||
LegislationClassification,
|
|
||||||
School,
|
|
||||||
Country,
|
|
||||||
Sponsor,
|
|
||||||
Category,
|
|
||||||
LegislationBook
|
|
||||||
]
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
{% extends "explorer/base.html" %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/tn.css" />
|
|
||||||
<div class="boxed">
|
|
||||||
<h1>All legislative texts</h1>
|
|
||||||
{% if legislative_texts %}
|
|
||||||
<ul>
|
|
||||||
{% for text in legislative_texts %}
|
|
||||||
<li><a href="{% url 'viewleg' text.id %}">{{ text.legislation_title }}</a></li>
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
{% else %}
|
|
||||||
<p>No texts available</p>
|
|
||||||
{% endif %}
|
|
||||||
</div>
|
|
||||||
{% endblock content %}
|
|
||||||
@ -1,30 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
<head>
|
|
||||||
{% if page_title %}
|
|
||||||
<title>explorer - {{ title }}</title>
|
|
||||||
{% else %}
|
|
||||||
<title>explorer</title>
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
<link rel="stylesheet" href="/static/style.css">
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
<nav id="navbar" class="boxed">
|
|
||||||
<div id="leftnav">
|
|
||||||
<a href="/explorer">explorer</a>
|
|
||||||
<a href="/knowledge">knowledge</a>
|
|
||||||
</div>
|
|
||||||
<div id="rightnav">
|
|
||||||
<a href="/explorer/all">all</a>
|
|
||||||
<a href="/explorer/groups">by group</a>
|
|
||||||
<a href="/explorer/search">search</a>
|
|
||||||
<a href="/explorer/stats">stats</a>
|
|
||||||
</div>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
{% endblock content %}
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
{% extends "explorer/base.html" %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/tn.css" />
|
|
||||||
|
|
||||||
<div class="boxed">
|
|
||||||
<h1>View legislation</h1>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
{% for name, url in listing.items %}
|
|
||||||
<li><a href="{{ url }}">By {{ name }}</a></li>
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
{% endblock content %}
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
{% extends "explorer/base.html" %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/tn.css" />
|
|
||||||
|
|
||||||
<div class="boxed">
|
|
||||||
<h1>All topics</h1>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
{% for topic in classifications %}
|
|
||||||
<li><a href="/explorer/topics/{{ topic.id }}">{{ topic.name }}</a></li>
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
{% endblock content %}
|
|
||||||
@ -1,38 +0,0 @@
|
|||||||
{% comment %}
|
|
||||||
This is a component -- I'm only using this because:
|
|
||||||
1. I'm too lazy to install django-components, and
|
|
||||||
2. This is the only time a component is necessary, so it doesn't make
|
|
||||||
any sense to take on an extra dependancy.
|
|
||||||
{% endcomment %}
|
|
||||||
<div class="legcomponent">
|
|
||||||
<a href="/explorer/legislation/{{ legislation.id }}"><h2 class="legtitle">{{ legislation.legislation_title }}</h2></a>
|
|
||||||
|
|
||||||
<div class="legmetadata">
|
|
||||||
<p>
|
|
||||||
<i>{{ legislation.assembly }}/{{ legislation.committee }}/{{ legislation.docket_order }}</i>
|
|
||||||
|
|
||||||
·
|
|
||||||
|
|
||||||
{% for sponsor in legislation.sponsors.all %}
|
|
||||||
<a href="/explorer/sponsors/{{ sponsor.id }}">{{ sponsor.name }}</a>{% if not forloop.last %}, {% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
|
|
||||||
·
|
|
||||||
|
|
||||||
<a href="/explorer/schools/{{ legislation.school.id }}">{{ legislation.school }}</a>
|
|
||||||
|
|
||||||
·
|
|
||||||
|
|
||||||
{% if legislation.country %}
|
|
||||||
<a href="/explorer/countries/{{ legislation.country.id }}">{{ legislation.country }}</a>
|
|
||||||
|
|
||||||
·
|
|
||||||
{% endif %}
|
|
||||||
<a href="/explorer/categories/{{ legislation.category.id }}">{{ legislation.category }}</a>
|
|
||||||
|
|
||||||
·
|
|
||||||
|
|
||||||
<a href="/explorer/conference/{{ legislation.from_book.id }}">{{ legislation.from_book.name }}</a>
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
@ -1,19 +0,0 @@
|
|||||||
{% extends "explorer/base.html" %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
{% if sample.is_bill %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/tn.css" />
|
|
||||||
{% elif sample.is_resolution %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/un.css" />
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
<div class="boxed">
|
|
||||||
<h1>{{ book.name }} Conference</h1>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
{% for text in legislation %}
|
|
||||||
<li><a href="/explorer/legislation/{{ text.id }}">{{ text.legislation_title }}</a></li>
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
{% endblock content %}
|
|
||||||
@ -1,32 +0,0 @@
|
|||||||
{% extends "explorer/base.html" %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/tn.css" />
|
|
||||||
<div class="boxed">
|
|
||||||
<h1>Welcome to explorer</h1>
|
|
||||||
|
|
||||||
<p><i>an interactive database for YMCA CCE legislation</i></p>
|
|
||||||
|
|
||||||
<h2>Some randomly selected legislation</h2>
|
|
||||||
|
|
||||||
{% if legislation %}
|
|
||||||
{% autoescape off %}
|
|
||||||
<ul>
|
|
||||||
{% for text in legislation %}
|
|
||||||
{{ text }}
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
{% endautoescape %}
|
|
||||||
{% else %}
|
|
||||||
<p>No texts available. If you're the admin, you need to add some texts with the admin interface.</p>
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
<h2>About this instance</h2>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
This is a self hosted instance of <i>explorer</i>, a Django web app for exploring resolutions and bills in YMCA CCE conferences.
|
|
||||||
It's licensed under the AGPL.
|
|
||||||
The source code is available <a href="https://git.beepboop.systems/stupidcomputer/yig">here</a> and <a href="https://github.com/stupidcomputer/yig">here</a>.
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
{% endblock content %}
|
|
||||||
@ -1,43 +0,0 @@
|
|||||||
{% extends "explorer/base.html" %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
{% if legislation.is_bill %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/tn.css" />
|
|
||||||
{% elif legislation.is_resolution %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/un.css" />
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
<div id="legcontainer">
|
|
||||||
<div id="leginfo" class="boxed">
|
|
||||||
<h1 class="no-margin-top">{{ legislation.legislation_title }}</h1>
|
|
||||||
|
|
||||||
<p><i>{{ legislation.assembly }}/{{ legislation.committee }}/{{ legislation.docket_order }}</i></p>
|
|
||||||
|
|
||||||
<p>Sponsored by
|
|
||||||
{% for sponsor in legislation.sponsors.all %}
|
|
||||||
<a href="/explorer/sponsors/{{ sponsor.id }}">{{ sponsor.name }}</a>{% if not forloop.last %}, {% endif %}
|
|
||||||
{% endfor %}
|
|
||||||
|
|
||||||
of <a href="/explorer/schools/{{ legislation.school.id }}">{{ legislation.school }}</a></p>
|
|
||||||
|
|
||||||
{% if legislation.country %}
|
|
||||||
<p>The delegates above represented the <a href="/explorer/countries/{{ legislation.country.id }}">Delegation of {{ legislation.country }}</a>.</p>
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
<p>This legislation was filed in the <a href="/explorer/categories/{{ legislation.category.id }}">{{ legislation.category }}</a> category</p>
|
|
||||||
|
|
||||||
<p>Presented as part of the <a href="/explorer/conference/{{ legislation.from_book.id }}">{{ legislation.from_book.name }}</a> conference</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div id="legislation" class="boxed">
|
|
||||||
<table>
|
|
||||||
{% for line in lines %}
|
|
||||||
<tr>
|
|
||||||
<td class="legnumbers">{{ line.linenumber }}</td>
|
|
||||||
<td>{{ line.linetext }}</td>
|
|
||||||
</tr>
|
|
||||||
{% endfor %}
|
|
||||||
</table>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
{% endblock content %}
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
{% extends "explorer/base.html" %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/tn.css" />
|
|
||||||
|
|
||||||
<div class="boxed">
|
|
||||||
<h1>{{ result_name }}</h1>
|
|
||||||
|
|
||||||
<ul>
|
|
||||||
{% for instance in instances %}
|
|
||||||
<li><a href="{{ instance.get_absolute_url }}">{{ instance.name }}</a></li>
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
</div>
|
|
||||||
{% endblock content %}
|
|
||||||
@ -1,17 +0,0 @@
|
|||||||
{% extends "explorer/base.html" %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/tn.css" />
|
|
||||||
|
|
||||||
<div class="boxed">
|
|
||||||
<h1>{{ result_name }}</h1>
|
|
||||||
|
|
||||||
{% autoescape off %}
|
|
||||||
<ul>
|
|
||||||
{% for text in legislation %}
|
|
||||||
{{ text }}
|
|
||||||
{% endfor %}
|
|
||||||
</ul>
|
|
||||||
{% endautoescape %}
|
|
||||||
</div>
|
|
||||||
{% endblock content %}
|
|
||||||
@ -1,15 +0,0 @@
|
|||||||
{% extends "explorer/base.html" %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/tn.css" />
|
|
||||||
<div class="boxed">
|
|
||||||
<h1>Search legislation by keyword</h1>
|
|
||||||
<form action="/explorer/search" method="get">
|
|
||||||
<input type="text" id="search_term" name="search_term" />
|
|
||||||
<button type="submit">Execute search</button>
|
|
||||||
<p>
|
|
||||||
You can use this page to search through legislation by keyword. The search is case sensitive, so be careful when pressing your shift key.
|
|
||||||
</p>
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
{% endblock %}
|
|
||||||
@ -1,28 +0,0 @@
|
|||||||
{% extends "explorer/base.html" %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
<link rel="stylesheet" type="text/css" href="/static/tn.css" />
|
|
||||||
<div class="boxed">
|
|
||||||
<h1>Explorer statistics</h1>
|
|
||||||
|
|
||||||
<p>Total pieces of legislation: {{ all }}</p>
|
|
||||||
|
|
||||||
<p>Red Senate Bills: {{ red_senate }}</p>
|
|
||||||
|
|
||||||
<p>White Senate Bills: {{ white_senate }}</p>
|
|
||||||
|
|
||||||
<p>Blue Senate Bills: {{ blue_senate }}</p>
|
|
||||||
|
|
||||||
<p>Red House Bills: {{ red_house }}</p>
|
|
||||||
|
|
||||||
<p>White House Bills: {{ white_house }}</p>
|
|
||||||
|
|
||||||
<p>Blue House Bills: {{ blue_house }}</p>
|
|
||||||
|
|
||||||
<p>Red General Assembly Resolutions: {{ red_ga }}</p>
|
|
||||||
|
|
||||||
<p>White General Assembly Resolutions: {{ white_ga }}</p>
|
|
||||||
|
|
||||||
<p>Blue General Assembly Resolutions: {{ blue_ga }}</p>
|
|
||||||
</div>
|
|
||||||
{% endblock content %}
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
from django.test import TestCase
|
|
||||||
|
|
||||||
# Create your tests here.
|
|
||||||
@ -1,26 +0,0 @@
|
|||||||
from django.urls import path
|
|
||||||
|
|
||||||
from . import views
|
|
||||||
|
|
||||||
urlpatterns = [
|
|
||||||
path("", views.index, name="index"),
|
|
||||||
path("all/", views.all, name="all"),
|
|
||||||
path("stats/", views.stats, name="stats"),
|
|
||||||
path("legislation/<int:legislation_id>/", views.view_legislation, name="viewleg"),
|
|
||||||
path("topics/<int:model_id>/", views.get_all_classified_by_id, name="LegislationClassification.detail"),
|
|
||||||
path("topics/", views.get_all_classifications, name="LegislationClassification"),
|
|
||||||
path("search/", views.handle_search, name="search_legislation"),
|
|
||||||
|
|
||||||
# these are named weirdly -- see models.py School and Country definitions
|
|
||||||
path("schools/<int:model_id>/", views.get_all_by_school, name="School.detail"),
|
|
||||||
path("countries/<int:model_id>/", views.get_all_by_country, name="Country.detail"),
|
|
||||||
path("sponsors/<int:model_id>/", views.get_all_by_sponsor, name="Sponsor.detail"),
|
|
||||||
path("categories/<int:model_id>/", views.get_all_by_category, name="Category.detail"),
|
|
||||||
path("conference/<int:model_id>/", views.get_all_by_conference, name="LegislationBook.detail"),
|
|
||||||
path("schools/", views.get_all_schools, name="School"),
|
|
||||||
path("countries/", views.get_all_countries, name="Country"),
|
|
||||||
path("groups/", views.return_groups, name="Groups"),
|
|
||||||
path("sponsors/", views.get_all_sponsors, name="Sponsor"),
|
|
||||||
path("categories/", views.get_all_categories, name="Category"),
|
|
||||||
path("conference/", views.get_all_conferences, name="LegislationBook"),
|
|
||||||
]
|
|
||||||
@ -1,184 +0,0 @@
|
|||||||
from django.shortcuts import get_object_or_404, render
|
|
||||||
from django.template.loader import render_to_string
|
|
||||||
from django.urls import reverse
|
|
||||||
from django.http import HttpResponse
|
|
||||||
|
|
||||||
from .models import (
|
|
||||||
LegislativeText,
|
|
||||||
LegislationBook,
|
|
||||||
LegislationClassification,
|
|
||||||
School,
|
|
||||||
Country,
|
|
||||||
Sponsor,
|
|
||||||
Category,
|
|
||||||
models_in_index,
|
|
||||||
)
|
|
||||||
|
|
||||||
from random import sample
|
|
||||||
|
|
||||||
def legislation_to_html(legislation):
|
|
||||||
return render_to_string("explorer/comp_legislation.html", {
|
|
||||||
"legislation": legislation,
|
|
||||||
})
|
|
||||||
|
|
||||||
def index(request):
|
|
||||||
legislative_texts = list(LegislativeText.objects.all())
|
|
||||||
try:
|
|
||||||
legislative_texts = sample(legislative_texts, 5)
|
|
||||||
except ValueError:
|
|
||||||
# there's not enough texts, so just return nothing
|
|
||||||
legislative_texts = []
|
|
||||||
|
|
||||||
legislative_texts = [
|
|
||||||
legislation_to_html(text) for text in legislative_texts
|
|
||||||
]
|
|
||||||
|
|
||||||
context = {
|
|
||||||
"legislation": legislative_texts,
|
|
||||||
}
|
|
||||||
return render(request, "explorer/index.html", context)
|
|
||||||
|
|
||||||
def all(request):
|
|
||||||
legislative_texts = list(LegislativeText.objects.all())
|
|
||||||
context = {
|
|
||||||
"legislative_texts": legislative_texts,
|
|
||||||
}
|
|
||||||
return render(request, "explorer/all.html", context)
|
|
||||||
|
|
||||||
def view_legislation(request, legislation_id):
|
|
||||||
legislation = get_object_or_404(LegislativeText, pk=legislation_id)
|
|
||||||
context = {
|
|
||||||
"legislation": legislation,
|
|
||||||
"lines": legislation.get_lines()
|
|
||||||
}
|
|
||||||
return render(request, "explorer/legislation.html", context)
|
|
||||||
|
|
||||||
def view_conference(request, conference_id):
|
|
||||||
book = get_object_or_404(LegislationBook, pk=conference_id)
|
|
||||||
results = LegislativeText.objects.filter(from_book=book)
|
|
||||||
context = {
|
|
||||||
"book": book,
|
|
||||||
"legislation": results,
|
|
||||||
"sample": results[0]
|
|
||||||
}
|
|
||||||
return render(request, "explorer/conference.html", context)
|
|
||||||
|
|
||||||
def stats(request):
|
|
||||||
all_legislation = len(LegislativeText.objects.all())
|
|
||||||
context = {
|
|
||||||
"all": all_legislation,
|
|
||||||
"red_senate": len(LegislativeText.objects.filter(assembly="RSB")),
|
|
||||||
"blue_senate": len(LegislativeText.objects.filter(assembly="BSB")),
|
|
||||||
"white_senate": len(LegislativeText.objects.filter(assembly="WSB")),
|
|
||||||
"red_house": len(LegislativeText.objects.filter(assembly="RHB")),
|
|
||||||
"blue_house": len(LegislativeText.objects.filter(assembly="BHB")),
|
|
||||||
"white_house": len(LegislativeText.objects.filter(assembly="WHB")),
|
|
||||||
"red_ga": len(LegislativeText.objects.filter(assembly="RGA")),
|
|
||||||
"blue_ga": len(LegislativeText.objects.filter(assembly="BGA")),
|
|
||||||
"white_ga": len(LegislativeText.objects.filter(assembly="WGA")),
|
|
||||||
}
|
|
||||||
return render(request, "explorer/stats.html", context)
|
|
||||||
|
|
||||||
def get_all_classified_by_id(request, model_id):
|
|
||||||
classification = get_object_or_404(LegislationClassification, pk=model_id)
|
|
||||||
# this is very expensive; make a way for this to be cached please?
|
|
||||||
|
|
||||||
all_texts = LegislativeText.objects.all()
|
|
||||||
all_terms = classification.text_to_match.split(',')
|
|
||||||
all_terms = [i.lower() for i in all_terms]
|
|
||||||
|
|
||||||
matches = []
|
|
||||||
|
|
||||||
for text in all_texts:
|
|
||||||
for term in all_terms:
|
|
||||||
if term in text.text.lower():
|
|
||||||
matches.append(text)
|
|
||||||
break
|
|
||||||
|
|
||||||
return render(request, "explorer/results.html", {
|
|
||||||
"legislation": matches,
|
|
||||||
"result_name": "All legislation in topic {}".format(classification.name)
|
|
||||||
})
|
|
||||||
|
|
||||||
def get_all_by_x(model):
|
|
||||||
def wrapped(request, model_id):
|
|
||||||
instance = get_object_or_404(model, pk=model_id)
|
|
||||||
legislation = instance.legislativetext_set.all()
|
|
||||||
legislation = [legislation_to_html(i) for i in legislation]
|
|
||||||
return render(request, "explorer/results.html", {
|
|
||||||
"result_name": "All legislation by {}".format(instance.name),
|
|
||||||
"legislation": legislation
|
|
||||||
})
|
|
||||||
|
|
||||||
return wrapped
|
|
||||||
|
|
||||||
def get_all_xs(model):
|
|
||||||
def wrapper(request):
|
|
||||||
instances = model.objects.all()
|
|
||||||
try:
|
|
||||||
# what the heck, django?????
|
|
||||||
plural = model._meta.verbose_name_plural
|
|
||||||
except:
|
|
||||||
plural = model.__name__ + "s"
|
|
||||||
|
|
||||||
plural = plural.lower()
|
|
||||||
|
|
||||||
return render(request, "explorer/listing.html", {
|
|
||||||
"result_name": "All {}".format(plural),
|
|
||||||
"instances": instances,
|
|
||||||
})
|
|
||||||
|
|
||||||
return wrapper
|
|
||||||
|
|
||||||
def return_groups(request):
|
|
||||||
listing = {}
|
|
||||||
for model in models_in_index:
|
|
||||||
try:
|
|
||||||
name = model._meta.verbose_name.lower()
|
|
||||||
except:
|
|
||||||
name = model.__name__.lower()
|
|
||||||
|
|
||||||
listing[name] = reverse(model.__name__)
|
|
||||||
|
|
||||||
print(listing)
|
|
||||||
return render(request, "explorer/by_group.html", { "listing": listing })
|
|
||||||
|
|
||||||
def handle_search(request):
|
|
||||||
try:
|
|
||||||
query = request.GET['search_term']
|
|
||||||
except KeyError:
|
|
||||||
return render(request, "explorer/search.html", {})
|
|
||||||
|
|
||||||
f = LegislativeText.objects.filter
|
|
||||||
|
|
||||||
text_results = f(text__icontains=query)
|
|
||||||
title_results = f(legislation_title__icontains=query)
|
|
||||||
school_results = f(school__name__icontains=query)
|
|
||||||
sponsor_results = f(sponsors__name__icontains=query)
|
|
||||||
country_results = f(country__name__icontains=query)
|
|
||||||
|
|
||||||
results = text_results.union(
|
|
||||||
title_results,
|
|
||||||
school_results,
|
|
||||||
sponsor_results,
|
|
||||||
country_results
|
|
||||||
)
|
|
||||||
results = [legislation_to_html(i) for i in results]
|
|
||||||
|
|
||||||
return render(request, "explorer/results.html", {
|
|
||||||
"result_name": "Results for search term '{}'".format(query),
|
|
||||||
"legislation": results
|
|
||||||
})
|
|
||||||
|
|
||||||
get_all_by_school = get_all_by_x(School)
|
|
||||||
get_all_by_country = get_all_by_x(Country)
|
|
||||||
get_all_by_sponsor = get_all_by_x(Sponsor)
|
|
||||||
get_all_by_category = get_all_by_x(Category)
|
|
||||||
get_all_by_conference = get_all_by_x(LegislationBook)
|
|
||||||
|
|
||||||
get_all_schools = get_all_xs(School)
|
|
||||||
get_all_countries = get_all_xs(Country)
|
|
||||||
get_all_sponsors = get_all_xs(Sponsor)
|
|
||||||
get_all_categories = get_all_xs(Category)
|
|
||||||
get_all_classifications = get_all_xs(LegislationClassification)
|
|
||||||
get_all_conferences = get_all_xs(LegislationBook)
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
"""
|
|
||||||
ASGI config for franklincce project.
|
|
||||||
|
|
||||||
It exposes the ASGI callable as a module-level variable named ``application``.
|
|
||||||
|
|
||||||
For more information on this file, see
|
|
||||||
https://docs.djangoproject.com/en/4.2/howto/deployment/asgi/
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
|
|
||||||
from django.core.asgi import get_asgi_application
|
|
||||||
|
|
||||||
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'franklincce.settings')
|
|
||||||
|
|
||||||
application = get_asgi_application()
|
|
||||||
@ -1,132 +0,0 @@
|
|||||||
"""
|
|
||||||
Django settings for franklincce project.
|
|
||||||
|
|
||||||
Generated by 'django-admin startproject' using Django 4.2.12.
|
|
||||||
|
|
||||||
For more information on this file, see
|
|
||||||
https://docs.djangoproject.com/en/4.2/topics/settings/
|
|
||||||
|
|
||||||
For the full list of settings and their values, see
|
|
||||||
https://docs.djangoproject.com/en/4.2/ref/settings/
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import random
|
|
||||||
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
# Build paths inside the project like this: BASE_DIR / 'subdir'.
|
|
||||||
BASE_DIR = Path(__file__).resolve().parent.parent
|
|
||||||
|
|
||||||
SECRET_KEY = os.environ.get("SECRET_KEY")
|
|
||||||
if not SECRET_KEY:
|
|
||||||
print("[!!!] YOU'RE USING A RANDOM SECRET_KEY -- CHANGE THIS IF YOU'RE GOING INTO PROD")
|
|
||||||
SECRET_KEY = random.randint(1, 100000000000000)
|
|
||||||
|
|
||||||
DEBUG = bool(os.environ.get("DEBUG", default=0))
|
|
||||||
|
|
||||||
# 'DJANGO_ALLOWED_HOSTS' should be a single string of hosts with a space between each.
|
|
||||||
# For example: 'DJANGO_ALLOWED_HOSTS=localhost 127.0.0.1 [::1]'
|
|
||||||
try:
|
|
||||||
ALLOWED_HOSTS = os.environ.get("DJANGO_ALLOWED_HOSTS").split(" ")
|
|
||||||
except:
|
|
||||||
ALLOWED_HOSTS = ["127.0.0.1", "localhost"]
|
|
||||||
|
|
||||||
INSTALLED_APPS = [
|
|
||||||
'explorer.apps.ExplorerConfig',
|
|
||||||
'django.contrib.admin',
|
|
||||||
'django.contrib.auth',
|
|
||||||
'django.contrib.contenttypes',
|
|
||||||
'django.contrib.sessions',
|
|
||||||
'django.contrib.messages',
|
|
||||||
'django.contrib.staticfiles',
|
|
||||||
]
|
|
||||||
|
|
||||||
MIDDLEWARE = [
|
|
||||||
'django.middleware.security.SecurityMiddleware',
|
|
||||||
'django.contrib.sessions.middleware.SessionMiddleware',
|
|
||||||
'django.middleware.common.CommonMiddleware',
|
|
||||||
'django.middleware.csrf.CsrfViewMiddleware',
|
|
||||||
'django.contrib.auth.middleware.AuthenticationMiddleware',
|
|
||||||
'django.contrib.messages.middleware.MessageMiddleware',
|
|
||||||
'django.middleware.clickjacking.XFrameOptionsMiddleware',
|
|
||||||
]
|
|
||||||
|
|
||||||
ROOT_URLCONF = 'franklincce.urls'
|
|
||||||
|
|
||||||
TEMPLATES = [
|
|
||||||
{
|
|
||||||
'BACKEND': 'django.template.backends.django.DjangoTemplates',
|
|
||||||
'DIRS': [],
|
|
||||||
'APP_DIRS': True,
|
|
||||||
'OPTIONS': {
|
|
||||||
'context_processors': [
|
|
||||||
'django.template.context_processors.debug',
|
|
||||||
'django.template.context_processors.request',
|
|
||||||
'django.contrib.auth.context_processors.auth',
|
|
||||||
'django.contrib.messages.context_processors.messages',
|
|
||||||
],
|
|
||||||
},
|
|
||||||
},
|
|
||||||
]
|
|
||||||
|
|
||||||
WSGI_APPLICATION = 'franklincce.wsgi.application'
|
|
||||||
|
|
||||||
|
|
||||||
# Database
|
|
||||||
# https://docs.djangoproject.com/en/4.2/ref/settings/#databases
|
|
||||||
|
|
||||||
DATABASES = {
|
|
||||||
'default': {
|
|
||||||
'ENGINE': 'django.db.backends.sqlite3',
|
|
||||||
'NAME': BASE_DIR / 'db.sqlite3',
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
STATICFILES_DIRS = [
|
|
||||||
BASE_DIR / "static",
|
|
||||||
]
|
|
||||||
|
|
||||||
# Password validation
|
|
||||||
# https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators
|
|
||||||
|
|
||||||
AUTH_PASSWORD_VALIDATORS = [
|
|
||||||
{
|
|
||||||
'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
|
|
||||||
},
|
|
||||||
{
|
|
||||||
'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
|
|
||||||
},
|
|
||||||
]
|
|
||||||
|
|
||||||
# Internationalization
|
|
||||||
# https://docs.djangoproject.com/en/4.2/topics/i18n/
|
|
||||||
|
|
||||||
LANGUAGE_CODE = 'en-us'
|
|
||||||
|
|
||||||
TIME_ZONE = 'UTC'
|
|
||||||
|
|
||||||
USE_I18N = True
|
|
||||||
|
|
||||||
USE_TZ = True
|
|
||||||
|
|
||||||
|
|
||||||
# Static files (CSS, JavaScript, Images)
|
|
||||||
# https://docs.djangoproject.com/en/4.2/howto/static-files/
|
|
||||||
|
|
||||||
STATIC_URL = '/static/'
|
|
||||||
|
|
||||||
# Default primary key field type
|
|
||||||
# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field
|
|
||||||
|
|
||||||
STATIC_ROOT = BASE_DIR / "staticfiles"
|
|
||||||
|
|
||||||
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
|
|
||||||
|
|
||||||
CSRF_TRUSTED_ORIGINS = ["http://localhost:1337", "https://franklincce.beepboop.systems"]
|
|
||||||
@ -1,25 +0,0 @@
|
|||||||
"""
|
|
||||||
URL configuration for franklincce project.
|
|
||||||
|
|
||||||
The `urlpatterns` list routes URLs to views. For more information please see:
|
|
||||||
https://docs.djangoproject.com/en/4.2/topics/http/urls/
|
|
||||||
Examples:
|
|
||||||
Function views
|
|
||||||
1. Add an import: from my_app import views
|
|
||||||
2. Add a URL to urlpatterns: path('', views.home, name='home')
|
|
||||||
Class-based views
|
|
||||||
1. Add an import: from other_app.views import Home
|
|
||||||
2. Add a URL to urlpatterns: path('', Home.as_view(), name='home')
|
|
||||||
Including another URLconf
|
|
||||||
1. Import the include() function: from django.urls import include, path
|
|
||||||
2. Add a URL to urlpatterns: path('blog/', include('blog.urls'))
|
|
||||||
"""
|
|
||||||
from django.contrib import admin
|
|
||||||
from django.urls import include, path
|
|
||||||
from django.conf import settings
|
|
||||||
from django.conf.urls.static import static
|
|
||||||
|
|
||||||
urlpatterns = [
|
|
||||||
path('explorer/', include("explorer.urls")),
|
|
||||||
path('admin/', admin.site.urls),
|
|
||||||
] + static(settings.STATIC_URL, document_root=settings.STATIC_ROOT)
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
"""
|
|
||||||
WSGI config for franklincce project.
|
|
||||||
|
|
||||||
It exposes the WSGI callable as a module-level variable named ``application``.
|
|
||||||
|
|
||||||
For more information on this file, see
|
|
||||||
https://docs.djangoproject.com/en/4.2/howto/deployment/wsgi/
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
|
|
||||||
from django.core.wsgi import get_wsgi_application
|
|
||||||
|
|
||||||
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'franklincce.settings')
|
|
||||||
|
|
||||||
application = get_wsgi_application()
|
|
||||||
@ -1,22 +0,0 @@
|
|||||||
#!/nix/store/7hnr99nxrd2aw6lghybqdmkckq60j6l9-python3-3.11.9/bin/python
|
|
||||||
"""Django's command-line utility for administrative tasks."""
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
|
|
||||||
|
|
||||||
def main():
|
|
||||||
"""Run administrative tasks."""
|
|
||||||
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'franklincce.settings')
|
|
||||||
try:
|
|
||||||
from django.core.management import execute_from_command_line
|
|
||||||
except ImportError as exc:
|
|
||||||
raise ImportError(
|
|
||||||
"Couldn't import Django. Are you sure it's installed and "
|
|
||||||
"available on your PYTHONPATH environment variable? Did you "
|
|
||||||
"forget to activate a virtual environment?"
|
|
||||||
) from exc
|
|
||||||
execute_from_command_line(sys.argv)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
|
||||||
main()
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
django==4.2.12
|
|
||||||
pymupdf==1.23.26
|
|
||||||
gunicorn
|
|
||||||
@ -1,123 +0,0 @@
|
|||||||
:root {
|
|
||||||
--component-bg-color: rgba(10, 10, 10, 0.7);
|
|
||||||
--text-color: rgb(150, 150, 150);
|
|
||||||
--accented-text-color: rgb(255, 255, 255);
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
font-family: sans-serif;
|
|
||||||
}
|
|
||||||
|
|
||||||
a {
|
|
||||||
color: lightblue;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:active {
|
|
||||||
color: orangered;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:visited {
|
|
||||||
color: mediumpurple;
|
|
||||||
}
|
|
||||||
|
|
||||||
::-moz-selection ::selection {
|
|
||||||
color: blue;
|
|
||||||
}
|
|
||||||
|
|
||||||
nav#navbar {
|
|
||||||
display: flex; /* make it from left to right */
|
|
||||||
flex-direction: row;
|
|
||||||
background-color: var(--component-bg-color);
|
|
||||||
background-clip: padding-box;
|
|
||||||
padding-left: 10px;
|
|
||||||
padding-right: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#leftnav {
|
|
||||||
padding-right: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#rightnav {
|
|
||||||
padding-left: 10px;
|
|
||||||
|
|
||||||
/* make this part right justified */
|
|
||||||
margin-left: auto;
|
|
||||||
margin-right: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
#legcontainer {
|
|
||||||
display: flex;
|
|
||||||
flex-direction: row;
|
|
||||||
gap: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#leginfo {
|
|
||||||
width: 15em;
|
|
||||||
}
|
|
||||||
|
|
||||||
#legislation {
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1, h2, h3, h4, h5, h6 {
|
|
||||||
color: var(--accented-text-color);
|
|
||||||
word-wrap: break-word;
|
|
||||||
}
|
|
||||||
|
|
||||||
p, td, i, ul, li {
|
|
||||||
color: var(--text-color);
|
|
||||||
font-size: 16px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.no-margin-top {
|
|
||||||
margin-top: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.boxed {
|
|
||||||
margin-top: 10px;
|
|
||||||
padding: 5px;
|
|
||||||
padding-top: 0px;
|
|
||||||
border: solid 1px;
|
|
||||||
background-color: var(--component-bg-color);
|
|
||||||
border-radius: 15px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.legnumbers {
|
|
||||||
text-align: right;
|
|
||||||
user-select: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
@media only screen and (max-width: 280px) {
|
|
||||||
#rightnav {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@media only screen and (max-width: 570px) {
|
|
||||||
nav#navbar {
|
|
||||||
padding-bottom: 10px;
|
|
||||||
}
|
|
||||||
#legcontainer {
|
|
||||||
flex-direction: column;
|
|
||||||
padding-right: 10px;
|
|
||||||
}
|
|
||||||
#leginfo {
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
@media (pointer: coarse) {
|
|
||||||
#legcontainer {
|
|
||||||
flex-direction: column;
|
|
||||||
padding-right: 10px;
|
|
||||||
}
|
|
||||||
#leginfo {
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
p, td, i, ul, li {
|
|
||||||
font-size: 26px;
|
|
||||||
}
|
|
||||||
nav#navbar {
|
|
||||||
font-size: 40px;
|
|
||||||
margin-bottom: 10px;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 149 KiB |
@ -1,7 +0,0 @@
|
|||||||
body {
|
|
||||||
background-image: url("/static/tn-cap.jpg");
|
|
||||||
background-position: center;
|
|
||||||
background-attachment: fixed;
|
|
||||||
background-repeat: no-repeat;
|
|
||||||
background-size: cover;
|
|
||||||
}
|
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.8 MiB |
@ -1,7 +0,0 @@
|
|||||||
body {
|
|
||||||
background-image: url("/static/un-gen-asm.jpg");
|
|
||||||
background-position: center;
|
|
||||||
background-attachment: fixed;
|
|
||||||
background-repeat: no-repeat;
|
|
||||||
background-size: cover;
|
|
||||||
}
|
|
||||||
13
gen_kb.sh
13
gen_kb.sh
@ -1,13 +0,0 @@
|
|||||||
files=$(find kb -type f | awk -F'/' '{print $NF}')
|
|
||||||
IFS='
|
|
||||||
'
|
|
||||||
mkdir -p franklincce/staticfiles/kb
|
|
||||||
mkdir -p franklincce/staticfiles/root
|
|
||||||
|
|
||||||
for file in $files; do
|
|
||||||
without_extension=${file%.*}
|
|
||||||
echo $file, $without_extension
|
|
||||||
pandoc -s --template=./template.html -f markdown -t html -o "franklincce/staticfiles/kb/$without_extension.html" "kb/$without_extension.md" --lua-filter=links-to-html.lua
|
|
||||||
done
|
|
||||||
|
|
||||||
cp franklincce/staticfiles/kb/web_root.html franklincce/staticfiles/root/index.html
|
|
||||||
11
index.html
Normal file
11
index.html
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
<html>
|
||||||
|
<body>
|
||||||
|
<script src="https://mozilla.github.io/pdf.js/build/pdf.mjs" type="module"></script>
|
||||||
|
<script src="main.js"></script>
|
||||||
|
<script>
|
||||||
|
</script>
|
||||||
|
<div id="message"></div>
|
||||||
|
<input type="file" id="fileupload">
|
||||||
|
<button onclick="onFileUpload()">click me</button>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
@ -1,16 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Contributing to the knowledgebase"
|
|
||||||
---
|
|
||||||
|
|
||||||
1. If you haven't a GitHub account, [create one](https://github.com/signup) and sign in.
|
|
||||||
2. Navigate to the `yig` repository in the VSCode Web Editor, or click [here](https://github.dev/stupidcomputer/yig)
|
|
||||||
3. Click on the `kb/` directory on the sidebar.
|
|
||||||
4. Select an article that you'd like to change.
|
|
||||||
5. Make your changes.
|
|
||||||
6. Click on the 'source control' tab on the left (the one that looks like a tree)
|
|
||||||
7. Click the "plus" icon on all the entries in the left panel, and write a message explaining your changes, and then click "Commit and Push"
|
|
||||||
8. You'll get a prompt to create your own "fork"; say yes.
|
|
||||||
9. Navigate back to [Github](https://github.com) and click on the "yig" link in the upper left area.
|
|
||||||
10. Click the "Compare and pull request" button, then scroll down and click "create pull request".
|
|
||||||
|
|
||||||
Thanks for your contribution!
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
# franklincce kb
|
|
||||||
This directory contains the sources for the knowledge-base portion of the Franklin CCE Delegation's website.
|
|
||||||
It includes bill and resolution writing tips and guides.
|
|
||||||
If you want more information on contributing to the knowledge-base but you don't really know your way around git, see [here](./CONTRIBUTING.md).
|
|
||||||
@ -1,33 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Choosing a resolution topic"
|
|
||||||
---
|
|
||||||
|
|
||||||
This is a tricky thing.
|
|
||||||
You've already picked a country, and so you have to choose a topic to write your resolution on.
|
|
||||||
Here are some things to keep in mind as you're choosing a topic.
|
|
||||||
|
|
||||||
1. Choose a *worldwide* topic.
|
|
||||||
|
|
||||||
Unless you're requesting immediate aid in the wake of a disaster, personalized solutions (ie. solutions only applicable to one country) are not the point of the UN.
|
|
||||||
Make the solutions enumerated in your resolution applicable to other countries, too.
|
|
||||||
|
|
||||||
2. Choose a *memorable* topic.
|
|
||||||
|
|
||||||
Don't do a resolution about drilling wells in Africa for water, because that's been done to death.
|
|
||||||
Try to come up with a unique way to solve the problems at hand.
|
|
||||||
One of the components which your resolutions will be scored on is originality, so keep that in mind.
|
|
||||||
|
|
||||||
3. Choose a topic with an asymmetrical *information advantage*.
|
|
||||||
|
|
||||||
What is a topic with an "asymmetrical information advantage"?
|
|
||||||
It's a topic that is common and prevalant, but not a lot of people know the intricate details of.
|
|
||||||
Like the American healthcare system, or the ICAO.
|
|
||||||
This is less important than the other ones, but is still something to consider -- choose a topic with an information advantage and it makes it easier during debate.
|
|
||||||
|
|
||||||
4. Choose an *important* topic.
|
|
||||||
|
|
||||||
This is the most important one.
|
|
||||||
Choose a relevant topic.
|
|
||||||
If you're country's in the news recently, look there for inspiration.
|
|
||||||
|
|
||||||
Got a good idea? Great. Now it's time to [write your resolution](./writing-resolution.md).
|
|
||||||
10
kb/index.md
10
kb/index.md
@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Franklin CCE Knowledgebase"
|
|
||||||
---
|
|
||||||
|
|
||||||
## Model UN
|
|
||||||
|
|
||||||
- [Writing a resolution](./writing-resolution.md)
|
|
||||||
|
|
||||||
Want to see more articles in the knowledgebase?
|
|
||||||
[Learn how to contribute](./CONTRIBUTING.md).
|
|
||||||
@ -1,38 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Operative verbs reference"
|
|
||||||
---
|
|
||||||
|
|
||||||
- Accepts
|
|
||||||
- Adopts
|
|
||||||
- Agrees
|
|
||||||
- Appeals
|
|
||||||
- Approves
|
|
||||||
- Authorizes
|
|
||||||
- Calls upon
|
|
||||||
- Commends
|
|
||||||
- Considers
|
|
||||||
- Decides
|
|
||||||
- Declares
|
|
||||||
- Determines
|
|
||||||
- Directs
|
|
||||||
- Emphasizes
|
|
||||||
- Encourages
|
|
||||||
- Endorses
|
|
||||||
- Expresses appreciation
|
|
||||||
- Expresses hope
|
|
||||||
- Invites
|
|
||||||
- Notes
|
|
||||||
- Notes with approval
|
|
||||||
- Notes with concern
|
|
||||||
- Notes with satisfaction
|
|
||||||
- Proclaims
|
|
||||||
- Reaffirms
|
|
||||||
- Recommends
|
|
||||||
- Reminds
|
|
||||||
- Repeals
|
|
||||||
- Requests
|
|
||||||
- Resolves
|
|
||||||
- Suggests
|
|
||||||
- Supports
|
|
||||||
- Takes note
|
|
||||||
- Urges
|
|
||||||
@ -1,40 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Preambular verbs reference"
|
|
||||||
---
|
|
||||||
|
|
||||||
- Acknowledging
|
|
||||||
- Affirming
|
|
||||||
- Appreciating
|
|
||||||
- Approving
|
|
||||||
- Aware
|
|
||||||
- Bearing in mind
|
|
||||||
- Believing
|
|
||||||
- Commending
|
|
||||||
- Concerned
|
|
||||||
- Conscious
|
|
||||||
- Considering
|
|
||||||
- Convinced
|
|
||||||
- Desiring
|
|
||||||
- Emphasizing
|
|
||||||
- Expecting
|
|
||||||
- Expressing
|
|
||||||
- Fully aware
|
|
||||||
- Guided by
|
|
||||||
- Having adopted
|
|
||||||
- Having considered
|
|
||||||
- Having noted
|
|
||||||
- Having reviewed
|
|
||||||
- Mindful
|
|
||||||
- Noting
|
|
||||||
- Noting with approval
|
|
||||||
- Noting with concern
|
|
||||||
- Noting with satisfaction
|
|
||||||
- Observing
|
|
||||||
- Realising
|
|
||||||
- Recalling
|
|
||||||
- Recognizing
|
|
||||||
- Seeking
|
|
||||||
- Taking into consideration
|
|
||||||
- Underlining
|
|
||||||
- Welcoming
|
|
||||||
- Whereas
|
|
||||||
@ -1,6 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Franklin CCE Delegation website"
|
|
||||||
---
|
|
||||||
|
|
||||||
This website contains some materials for the Franklin High School YMCA Center for Civic Engagement delegation.
|
|
||||||
Specifically, a [bill database](/explorer) and a [collection of helpful articles](/knowledge) on various things are available here.
|
|
||||||
@ -1,67 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Writing a Resolution"
|
|
||||||
---
|
|
||||||
|
|
||||||
*Note: This guide assumes you've already choosen a topic; if not, see [Choosing a resolution topic](./choosing-topic-resolution.md).*
|
|
||||||
|
|
||||||
The General Assembly, the largest law-making body of the UN, expresses its intentions and actions as a *resolution*.
|
|
||||||
In this article, we'll learn how to write one.
|
|
||||||
|
|
||||||
A resolution is composed of two parts: the *preambulatory* (or preambular) and *operative* clauses.
|
|
||||||
Preambulatory clauses provide background on why your resolution is needed, the problem it addresses, and sets the tone for the operative clauses.
|
|
||||||
Operative clauses are the items of action; they are directives that countries agree to.
|
|
||||||
(Only the Security Council has the power of passing *mandatory* directives.)
|
|
||||||
|
|
||||||
As an example, let's assume we're writing a resolution that condemns kicking puppies. (I would hope that you'd agree with the premise; if not -- that's an interesting opinion.) There was a recent puppy kicking event in the country of `Madeupia`, so let's note that:
|
|
||||||
|
|
||||||
> Noting with concern the International Puppy Kicking Event held in `Madeupia` on 22 September 2024, where various kinds of dogs were subject to unconsionable acts of depravity and abuse;
|
|
||||||
|
|
||||||
This is a good example of a preambulatory clause -- it states background for the operative clauses. If someone asked you if people actually kick dogs, this is your response. It demonstrates the necessity of the resolution.
|
|
||||||
|
|
||||||
There also might be past resulutions about animal abuse or dogs, so it might be prudent to mention those, too:
|
|
||||||
|
|
||||||
> Affirming resolution UNEP/5/1, which specifically emphasizes the value of animals and the contributions their welfare makes to the UN Sustainable Development Goals,
|
|
||||||
|
|
||||||
You essentially want to create many of these preambulatory clauses to paint a vivid picture of the need of your resolution. If you want to see more verbs to go in front of your preambulatory clauses, check out the [preambulatory verbs reference](./preambular-verbs.md).
|
|
||||||
|
|
||||||
Once you're done writing your preambulatory clauses, you write:
|
|
||||||
|
|
||||||
> The General Assembly hereby:
|
|
||||||
|
|
||||||
You do **NOT** write:
|
|
||||||
|
|
||||||
> The Delegation of (your country here) hereby:
|
|
||||||
|
|
||||||
because the resolution is adopted by the Assembly. That's why there's a vote and stuff -- if a country wants to express a feeling it feels by itself, it can submit a Communique to the UN instead.
|
|
||||||
|
|
||||||
Now it's time to talk about operative clauses.
|
|
||||||
These clauses are where the actual works gets done.
|
|
||||||
I think a good first move is the condemn the country of `Madeupia` for their puppy kicking event:
|
|
||||||
|
|
||||||
> Condemns, in the strongest terms, the affront to animal welfare perpetuated by the State of Madeupia;
|
|
||||||
|
|
||||||
Here are some other forms of clauses you might want to consider:
|
|
||||||
|
|
||||||
> Takes note of the report of the Secretary-General on "Animal Welfare as it pertains to the advancement of the SDGs";
|
|
||||||
>
|
|
||||||
> Expresses support of the Totally Real Animal Anti-Violence Directorate of the United Nations and their actions in response to this issue;
|
|
||||||
>
|
|
||||||
> Recognizes the positive contribution of various Member States towards the resolution of this issue, including the Republic of Dog Lovers;
|
|
||||||
|
|
||||||
Do note -- when you're ending your resolution, your final clause ends with a period.
|
|
||||||
|
|
||||||
> Requests the Secretary-General to submit a report on the implementation of the present resolution including recommendations for future action at the next session of the General Assembly.
|
|
||||||
|
|
||||||
For a full list of operative verbs, see the [operative verbs reference](./operative-verbs.md).
|
|
||||||
|
|
||||||
One final note: if you use a comma in any of your clauses, all of the clauses (except the last one) have to end in a semicolon.
|
|
||||||
This is because of the rules of Standard English.
|
|
||||||
|
|
||||||
## Some other resources for resolution writing
|
|
||||||
|
|
||||||
- [The UN's Model UN resources](https://www.un.org/en/model-united-nations/drafting-resolutions)
|
|
||||||
|
|
||||||
The UN does say some different things in this article -- it talks about L-documents and agreement annotations and soliciting agreement from other delegations beforehand.
|
|
||||||
That's not relevant to our conference, but it is still a good resource.
|
|
||||||
|
|
||||||
For an example of a finished resolution that is somewhat up to format, see the heading "Compilation Text as of 21 October 2016 (Rev. 3) The General Assembly".
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
function Link(el)
|
|
||||||
el.target = string.gsub(el.target, "%.md", ".html")
|
|
||||||
return el
|
|
||||||
end
|
|
||||||
116
main.js
Normal file
116
main.js
Normal file
@ -0,0 +1,116 @@
|
|||||||
|
var {pdfjsLib} = globalThis;
|
||||||
|
|
||||||
|
function concatLines(lines) {
|
||||||
|
output = "";
|
||||||
|
for (var line = 0; line < lines.length; line++) {
|
||||||
|
output += lines[line].str;
|
||||||
|
}
|
||||||
|
return output;
|
||||||
|
}
|
||||||
|
|
||||||
|
function fillInCommitteePages(pages) { // TODO: make this more efficent
|
||||||
|
output = []
|
||||||
|
for(var i = pages[0]; i < pages[pages.length - 1]; i++) {
|
||||||
|
if (!pages.includes(i)) output.push(i)
|
||||||
|
}
|
||||||
|
return output
|
||||||
|
}
|
||||||
|
|
||||||
|
function concatAllCommitteePages(committeePages, allLines) {
|
||||||
|
output = []
|
||||||
|
for (var i = 0; i < committeePages.length; i++) {
|
||||||
|
output = output.concat(allLines[committeePages[i]])
|
||||||
|
}
|
||||||
|
return output;
|
||||||
|
}
|
||||||
|
|
||||||
|
function splitByBillHeader(committeeLines, billHeader) {
|
||||||
|
output = [];
|
||||||
|
current = [];
|
||||||
|
for (var i = 0; i < committeeLines.length; i++) {
|
||||||
|
if(committeeLines[i].str == billHeader) {
|
||||||
|
output.push(current);
|
||||||
|
current = [];
|
||||||
|
} else {
|
||||||
|
current.push(committeeLines[i])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
output.shift()
|
||||||
|
return output;
|
||||||
|
}
|
||||||
|
|
||||||
|
function extractBillInformation(splittedByBillHeader) {
|
||||||
|
var output = [];
|
||||||
|
for (var i = 0; i < splittedByBillHeader.length; i++) {
|
||||||
|
current = splittedByBillHeader[i];
|
||||||
|
console.log(current)
|
||||||
|
var subcommittee = current[31].str;
|
||||||
|
var sponsors = current[33].str;
|
||||||
|
var school = current[35].str;
|
||||||
|
var billcode = current[5].str;
|
||||||
|
|
||||||
|
output.push({
|
||||||
|
subcommittee: subcommittee,
|
||||||
|
sponsors: sponsors,
|
||||||
|
school: school,
|
||||||
|
billcode: billcode,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return output;
|
||||||
|
}
|
||||||
|
|
||||||
|
function processLines(lines) {
|
||||||
|
var committeePages = [];
|
||||||
|
var endPage = null;
|
||||||
|
for (var i = 0; i < lines.length; i++) {
|
||||||
|
var concatted = concatLines(lines[i])
|
||||||
|
if (concatted.includes("COMMITTEE") && concatted.includes("GOVERNMENT")) { // we have a committee page
|
||||||
|
committeePages.push(i)
|
||||||
|
} else if (concatted.includes("ABCs")) {
|
||||||
|
endPage = i;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
committeePages.push(endPage)
|
||||||
|
committeeLines =
|
||||||
|
concatAllCommitteePages(
|
||||||
|
fillInCommitteePages(
|
||||||
|
committeePages
|
||||||
|
), lines
|
||||||
|
)
|
||||||
|
|
||||||
|
billHeader = committeeLines[0].str;
|
||||||
|
committeeLines.push({str: billHeader})
|
||||||
|
|
||||||
|
splittedByBillHeader = splitByBillHeader(committeeLines, billHeader)
|
||||||
|
billInfo = extractBillInformation(splittedByBillHeader);
|
||||||
|
console.log(billInfo)
|
||||||
|
}
|
||||||
|
|
||||||
|
function onFileUpload() {
|
||||||
|
const reader = new FileReader()
|
||||||
|
var result = null;
|
||||||
|
reader.onload = function(evt) {
|
||||||
|
const contents = evt.target.result;
|
||||||
|
pdfjsLib.GlobalWorkerOptions.workerSrc = '//mozilla.github.io/pdf.js/build/pdf.worker.mjs';
|
||||||
|
var task = pdfjsLib.getDocument({data: contents});
|
||||||
|
var result = task.promise.then(function(pdf) {
|
||||||
|
var pageCount = pdf.numPages;
|
||||||
|
var promises = [];
|
||||||
|
for (var i = 1; i <= pageCount; i++) {
|
||||||
|
var page = pdf.getPage(i);
|
||||||
|
promises.push(page.then(function(page) {
|
||||||
|
var textContent = page.getTextContent();
|
||||||
|
return textContent.then(function(text) {
|
||||||
|
return text.items;
|
||||||
|
})
|
||||||
|
}))
|
||||||
|
}
|
||||||
|
Promise.all(promises).then(function(lines) {
|
||||||
|
processLines(lines)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
reader.readAsBinaryString(document.getElementById("fileupload").files[0])
|
||||||
|
}
|
||||||
@ -1,4 +0,0 @@
|
|||||||
FROM nginx:1.25
|
|
||||||
|
|
||||||
RUN rm /etc/nginx/conf.d/default.conf
|
|
||||||
COPY nginx.conf /etc/nginx/conf.d
|
|
||||||
@ -1,39 +0,0 @@
|
|||||||
upstream franklincce {
|
|
||||||
server web:8000;
|
|
||||||
}
|
|
||||||
|
|
||||||
server {
|
|
||||||
listen 80;
|
|
||||||
server_name franklincce.beepboop.systems;
|
|
||||||
port_in_redirect off;
|
|
||||||
absolute_redirect off;
|
|
||||||
server_name_in_redirect off;
|
|
||||||
|
|
||||||
location /explorer/ {
|
|
||||||
proxy_pass http://franklincce;
|
|
||||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_redirect off;
|
|
||||||
client_max_body_size 100M;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /admin/ {
|
|
||||||
proxy_pass http://franklincce;
|
|
||||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_redirect off;
|
|
||||||
client_max_body_size 100M;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /static/ {
|
|
||||||
alias /home/app/web/staticfiles/;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /knowledge {
|
|
||||||
alias /home/app/web/staticfiles/kb;
|
|
||||||
}
|
|
||||||
|
|
||||||
location / {
|
|
||||||
alias /home/app/web/staticfiles/root/;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@ -1,4 +0,0 @@
|
|||||||
{ pkgs ? import <nixpkgs> {} }:
|
|
||||||
pkgs.mkShell {
|
|
||||||
nativeBuildInputs = with pkgs.python311Packages; [ django pymupdf ] ++ [ pkgs.docker-compose pkgs.gnumake pkgs.pandoc ] ;
|
|
||||||
}
|
|
||||||
@ -1,27 +0,0 @@
|
|||||||
<!DOCTYPE html>
|
|
||||||
<html>
|
|
||||||
|
|
||||||
<head>
|
|
||||||
<meta charset="utf-8" />
|
|
||||||
<meta name="generator" content="pandoc" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
|
|
||||||
<title>$title$</title>
|
|
||||||
<link rel="stylesheet" href="/static/style.css">
|
|
||||||
<link rel="stylesheet" href="/static/tn.css">
|
|
||||||
</head>
|
|
||||||
|
|
||||||
<body>
|
|
||||||
<nav id="navbar" class="boxed">
|
|
||||||
<div id="leftnav">
|
|
||||||
<a href="/explorer">explorer</a>
|
|
||||||
<a href="/knowledge">knowledge</a>
|
|
||||||
</div>
|
|
||||||
</nav>
|
|
||||||
|
|
||||||
<div class="boxed">
|
|
||||||
<h1>$title$</h1>
|
|
||||||
$body$
|
|
||||||
</div>
|
|
||||||
</body>
|
|
||||||
|
|
||||||
</html>
|
|
||||||
Loading…
Reference in New Issue
Block a user