Skip to content

Commit e170a92

Browse files
luiztoskluiztosk
committed
add documentation and license for ptbr-aosp-10k
1 parent cd5877c commit e170a92

File tree

2 files changed

+175
-1
lines changed

2 files changed

+175
-1
lines changed

‎LICENSE-ptbr-aosp-10k.md‎

Lines changed: 173 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,173 @@
1+
2+
The list of Brazilian Portuguese words, `ptbr-aosp-10k`, is the `filtered-top-10k`
3+
word list generated by Fabricio C Zuardi's [ptbr-wordlist](https://github.com/fczuardi/ptbr-wordlist).
4+
5+
It takes the PT-BR dictionary from the [AOSP](https://android.googlesource.com/platform/packages/inputmethods/LatinIME/)
6+
project, filters short, accented and too similar words and keeps the most frequent
7+
10k words ([Attributes of a "good enough" wordlist](https://github.com/fczuardi/ptbr-wordlist?tab=readme-ov-file#attributes-of-a-good-enough-wordlist)).
8+
9+
[ptbr-wordlist](https://github.com/fczuardi/ptbr-wordlist) is under the MIT License,
10+
while the integral NOTICE text from the
11+
[LatinIME AOSP repository](https://android.googlesource.com/platform/packages/inputmethods/LatinIME/)
12+
under the Apache License is provided below.
13+
14+
15+
16+
Copyright (c) 2008, The Android Open Source Project
17+
Licensed under the Apache License, Version 2.0 (the "License");
18+
you may not use this file except in compliance with the License.
19+
Unless required by applicable law or agreed to in writing, software
20+
distributed under the License is distributed on an "AS IS" BASIS,
21+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22+
See the License for the specific language governing permissions and
23+
limitations under the License.
24+
Apache License
25+
Version 2.0, January 2004
26+
http://www.apache.org/licenses/
27+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
28+
1. Definitions.
29+
"License" shall mean the terms and conditions for use, reproduction,
30+
and distribution as defined by Sections 1 through 9 of this document.
31+
"Licensor" shall mean the copyright owner or entity authorized by
32+
the copyright owner that is granting the License.
33+
"Legal Entity" shall mean the union of the acting entity and all
34+
other entities that control, are controlled by, or are under common
35+
control with that entity. For the purposes of this definition,
36+
"control" means (i) the power, direct or indirect, to cause the
37+
direction or management of such entity, whether by contract or
38+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
39+
outstanding shares, or (iii) beneficial ownership of such entity.
40+
"You" (or "Your") shall mean an individual or Legal Entity
41+
exercising permissions granted by this License.
42+
"Source" form shall mean the preferred form for making modifications,
43+
including but not limited to software source code, documentation
44+
source, and configuration files.
45+
"Object" form shall mean any form resulting from mechanical
46+
transformation or translation of a Source form, including but
47+
not limited to compiled object code, generated documentation,
48+
and conversions to other media types.
49+
"Work" shall mean the work of authorship, whether in Source or
50+
Object form, made available under the License, as indicated by a
51+
copyright notice that is included in or attached to the work
52+
(an example is provided in the Appendix below).
53+
"Derivative Works" shall mean any work, whether in Source or Object
54+
form, that is based on (or derived from) the Work and for which the
55+
editorial revisions, annotations, elaborations, or other modifications
56+
represent, as a whole, an original work of authorship. For the purposes
57+
of this License, Derivative Works shall not include works that remain
58+
separable from, or merely link (or bind by name) to the interfaces of,
59+
the Work and Derivative Works thereof.
60+
"Contribution" shall mean any work of authorship, including
61+
the original version of the Work and any modifications or additions
62+
to that Work or Derivative Works thereof, that is intentionally
63+
submitted to Licensor for inclusion in the Work by the copyright owner
64+
or by an individual or Legal Entity authorized to submit on behalf of
65+
the copyright owner. For the purposes of this definition, "submitted"
66+
means any form of electronic, verbal, or written communication sent
67+
to the Licensor or its representatives, including but not limited to
68+
communication on electronic mailing lists, source code control systems,
69+
and issue tracking systems that are managed by, or on behalf of, the
70+
Licensor for the purpose of discussing and improving the Work, but
71+
excluding communication that is conspicuously marked or otherwise
72+
designated in writing by the copyright owner as "Not a Contribution."
73+
"Contributor" shall mean Licensor and any individual or Legal Entity
74+
on behalf of whom a Contribution has been received by Licensor and
75+
subsequently incorporated within the Work.
76+
2. Grant of Copyright License. Subject to the terms and conditions of
77+
this License, each Contributor hereby grants to You a perpetual,
78+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
79+
copyright license to reproduce, prepare Derivative Works of,
80+
publicly display, publicly perform, sublicense, and distribute the
81+
Work and such Derivative Works in Source or Object form.
82+
3. Grant of Patent License. Subject to the terms and conditions of
83+
this License, each Contributor hereby grants to You a perpetual,
84+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
85+
(except as stated in this section) patent license to make, have made,
86+
use, offer to sell, sell, import, and otherwise transfer the Work,
87+
where such license applies only to those patent claims licensable
88+
by such Contributor that are necessarily infringed by their
89+
Contribution(s) alone or by combination of their Contribution(s)
90+
with the Work to which such Contribution(s) was submitted. If You
91+
institute patent litigation against any entity (including a
92+
cross-claim or counterclaim in a lawsuit) alleging that the Work
93+
or a Contribution incorporated within the Work constitutes direct
94+
or contributory patent infringement, then any patent licenses
95+
granted to You under this License for that Work shall terminate
96+
as of the date such litigation is filed.
97+
4. Redistribution. You may reproduce and distribute copies of the
98+
Work or Derivative Works thereof in any medium, with or without
99+
modifications, and in Source or Object form, provided that You
100+
meet the following conditions:
101+
(a) You must give any other recipients of the Work or
102+
Derivative Works a copy of this License; and
103+
(b) You must cause any modified files to carry prominent notices
104+
stating that You changed the files; and
105+
(c) You must retain, in the Source form of any Derivative Works
106+
that You distribute, all copyright, patent, trademark, and
107+
attribution notices from the Source form of the Work,
108+
excluding those notices that do not pertain to any part of
109+
the Derivative Works; and
110+
(d) If the Work includes a "NOTICE" text file as part of its
111+
distribution, then any Derivative Works that You distribute must
112+
include a readable copy of the attribution notices contained
113+
within such NOTICE file, excluding those notices that do not
114+
pertain to any part of the Derivative Works, in at least one
115+
of the following places: within a NOTICE text file distributed
116+
as part of the Derivative Works; within the Source form or
117+
documentation, if provided along with the Derivative Works; or,
118+
within a display generated by the Derivative Works, if and
119+
wherever such third-party notices normally appear. The contents
120+
of the NOTICE file are for informational purposes only and
121+
do not modify the License. You may add Your own attribution
122+
notices within Derivative Works that You distribute, alongside
123+
or as an addendum to the NOTICE text from the Work, provided
124+
that such additional attribution notices cannot be construed
125+
as modifying the License.
126+
You may add Your own copyright statement to Your modifications and
127+
may provide additional or different license terms and conditions
128+
for use, reproduction, or distribution of Your modifications, or
129+
for any such Derivative Works as a whole, provided Your use,
130+
reproduction, and distribution of the Work otherwise complies with
131+
the conditions stated in this License.
132+
5. Submission of Contributions. Unless You explicitly state otherwise,
133+
any Contribution intentionally submitted for inclusion in the Work
134+
by You to the Licensor shall be under the terms and conditions of
135+
this License, without any additional terms or conditions.
136+
Notwithstanding the above, nothing herein shall supersede or modify
137+
the terms of any separate license agreement you may have executed
138+
with Licensor regarding such Contributions.
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
8. Limitation of Liability. In no event and under no legal theory,
153+
whether in tort (including negligence), contract, or otherwise,
154+
unless required by applicable law (such as deliberate and grossly
155+
negligent acts) or agreed to in writing, shall any Contributor be
156+
liable to You for damages, including any direct, indirect, special,
157+
incidental, or consequential damages of any character arising as a
158+
result of this License or out of the use or inability to use the
159+
Work (including but not limited to damages for loss of goodwill,
160+
work stoppage, computer failure or malfunction, or any and all
161+
other commercial damages or losses), even if such Contributor
162+
has been advised of the possibility of such damages.
163+
9. Accepting Warranty or Additional Liability. While redistributing
164+
the Work or Derivative Works thereof, You may choose to offer,
165+
and charge a fee for, acceptance of support, warranty, indemnity,
166+
or other liability obligations and/or rights consistent with this
167+
License. However, in accepting such obligations, You may act only
168+
on Your own behalf and on Your sole responsibility, not on behalf
169+
of any other Contributor, and only if You agree to indemnify,
170+
defend, and hold each Contributor harmless for any liability
171+
incurred by, or claims asserted against, such Contributor by reason
172+
of your accepting any such warranty or additional liability.
173+
END OF TERMS AND CONDITIONS

‎README.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ A concise overview of the available ``xkcdpass`` options can be accessed via::
8585
eff-special, legacy, spa-mich (Spanish), fin-kotus (Finnish)
8686
ita-wiki (Italian), ger-anlx, ger-long, ger-short (German), nor-nb (Norwegian),
8787
fr-freelang (French), pt-ipublicis / pt-l33t-ipublicis (Portuguese)
88-
swe-short (Swedish)
88+
ptbr-aosp-10k (Portuguese (Brazil)), swe-short (Swedish)
8989
--min=MIN_LENGTH
9090
Minimum length of words to make password
9191
--max=MAX_LENGTH
@@ -146,6 +146,7 @@ Additional languages
146146
- Norwegian: a modified version of `Norsk Ordbank in Norwegian Bokmål 2005 <https://www.nb.no/sprakbanken/show?serial=oai%3Anb.no%3Asbr-5&lang=en>`_, 2018-06-28 update, which is released under the `CC-BY 4.0 license <https://creativecommons.org/licenses/by/4.0/>`_. Regex has been used to alter the list for cleanup and removal of words with impractical characters. The resulting list contains ~137k words.
147147
- French: One cleaned version of `this list <https://packetstormsecurity.com/files/download/32007/french.gz>`_ (public domain), and one filtered to remove potentially offensive words.
148148
- Portuguese: Converted variant of the LibreOffice / Firefox Portuguese dictionary (from `this link <https://raw.githubusercontent.com/titoBouzout/Dictionaries/master/Portuguese%20(European).dic>`_. GPL and BSD licenced.
149+
- Portuguese Brazil (ptbr-aosp-10k) 10k words filtered from the LatinIME(AOSP) pt-br dictionary `<https://android.googlesource.com/platform/packages/inputmethods/LatinIME/>` (Apache License, more details in the file `LICENSE-ptbr-aosp-10k.md`) using `Fabricio C Zuardi's ptbr-wordlist <https://github.com/fczuardi/ptbr-wordlist> (MIT License)`.
149150
- Swedish: a modified version of `Martin Lindhe's Swedish word list <https://github.com/martinlindhe/wordlist_swedish>`_ (MIT license). Modifications also released under MIT license.
150151

151152
Additional language word lists are always welcome!

0 commit comments

Comments
 (0)