GodsDevProject commited on
Commit
bf54ebf
Β·
verified Β·
1 Parent(s): 8975783

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +34 -140
README.md CHANGED
@@ -1,168 +1,62 @@
1
- ---
2
- title: Federal FOIA Intelligence Search
3
- emoji: πŸ›οΈ
4
- colorFrom: blue
5
- colorTo: gray
6
- sdk: gradio
7
- sdk_version: 6.3.0
8
- app_file: app.py
9
- pinned: true
10
- license: mit
11
- short_description: 'FOIA DECLASSIFIED DOCUMENTS SEARCH '
12
- ---
13
-
14
- # Federal FOIA Intelligence Search
15
  ### Public Electronic Reading Rooms Only
16
 
17
- A **live, robots-compliant search application** for discovering publicly released U.S. government documents available in **FOIA Electronic Reading Rooms**.
18
-
19
- This Space is designed for **journalists, researchers, historians, attorneys, and the general public** to explore already-public government records β€” **not to access classified, restricted, or non-public information**.
20
 
21
  ---
22
 
23
  ## βœ… What This App Does
24
-
25
- - πŸ” Searches **public FOIA Electronic Reading Rooms**
26
- - 🌐 Uses **live queries** only where automated access is explicitly permitted
27
- - πŸ€– Enforces **robots.txt compliance per agency**
28
- - 🧾 Clearly distinguishes **live results vs. stub (non-live) sources**
29
- - πŸ“¦ Allows export of results for research and reporting
30
- - βš–οΈ Designed to comply with **FOIA, HF policies, and U.S. law**
31
 
32
  ---
33
 
34
- ## 🚫 What This App Does NOT Do
35
-
36
- - ❌ No scraping of restricted or protected systems
37
- - ❌ No bypassing of authentication, paywalls, or CAPTCHAs
38
- - ❌ No access to classified, controlled, or non-public data
39
- - ❌ No querying of intelligence systems or operational databases
40
- - ❌ No real-time surveillance or monitoring
41
-
42
- ---
43
-
44
- ## 🟒 Live Sources (Queried in Real Time)
45
-
46
- These agencies provide **public FOIA search endpoints** and explicitly permit automated access:
47
 
48
- - **CIA** – FOIA Electronic Reading Room
49
- - **FBI Vault**
50
- - **Department of Justice (DOJ)** – FOIA Library
51
- - **Department of Homeland Security (DHS)** – FOIA Library
52
- - **U.S. Department of State** – FOIA Search
53
- - **General Services Administration (GSA)** – FOIA Library
54
 
55
- Live sources are:
56
- - Rate-limited
57
- - Queried read-only
58
- - Checked against robots.txt before each use
59
-
60
- ---
61
-
62
- ## 🟑 Stub-Only Sources (Transparency Mode)
63
-
64
- Some agencies **do not permit automated querying**, **block access via robots.txt**, or **do not provide a public FOIA search endpoint**.
65
-
66
- These are represented as **clearly labeled stub adapters** for transparency only.
67
-
68
- Stub sources **DO NOT perform live queries**.
69
-
70
- ### Stub Sources Include:
71
  - NSA
72
- - NRO
73
- - DIA
74
  - NGA
75
- - Special Access Programs (SAP)
76
- - TEN-CAP
77
- - AATIP
78
- - Special Activities
79
-
80
- ---
81
 
82
- ## ⚠️ Extended Features (User Warning)
 
 
 
83
 
84
- An optional **Extended Features** mode allows users to include **stub-only results**.
85
-
86
- Before enabling, users must explicitly acknowledge that:
87
- - No live queries will be performed
88
- - Results are informational only
89
- - Some agencies are restricted by law or policy
90
-
91
- This design prevents misuse while maintaining public-interest transparency.
92
-
93
- ---
94
-
95
- ## πŸ›‘οΈ Trust, Safety & Compliance
96
-
97
- This Space was designed with the following safeguards:
98
-
99
- - βœ… **robots.txt enforcement** per adapter
100
- - βœ… **No authentication or credential use**
101
- - βœ… **Public-domain / public-release content only**
102
- - βœ… **Clear labeling of non-live sources**
103
- - βœ… **User acknowledgment for extended features**
104
- - βœ… **Read-only access**
105
- - βœ… **No data retention or tracking**
106
-
107
- The application complies with:
108
- - U.S. Freedom of Information Act (FOIA)
109
- - Hugging Face Spaces policies
110
- - Standard web crawling norms
111
- - Public-interest research standards
112
 
113
  ---
114
 
115
- ## πŸ“¦ Export & Research Use
116
-
117
- Users may export search results as a ZIP archive for:
118
- - Journalism
119
- - Academic research
120
- - Legal analysis
121
- - Historical archiving
122
-
123
- Exports include:
124
- - Source agency
125
- - Document title
126
- - Public URL
127
- - Snippet / context
128
 
129
  ---
130
 
131
- ## πŸ‘©β€βš–οΈ Legal & Policy Notes
132
-
133
- - This tool does **not replace formal FOIA requests**
134
- - It only indexes **already-public disclosures**
135
- - For non-public records, users should submit FOIA requests directly to agencies
136
- - Inclusion of an agency name does **not imply live access**
137
-
138
- ---
139
-
140
- ## πŸ§ͺ Technical Overview
141
-
142
- - **Frontend:** Gradio (HF Spaces)
143
- - **Architecture:** Async federated adapters
144
- - **Safety:** Per-adapter robots enforcement
145
- - **Design:** Explicit live vs stub separation
146
- - **Deployment:** Single `app.py` entrypoint
147
-
148
- ---
149
-
150
- ## 🧭 Intended Audience
151
-
152
- - Journalists
153
- - Researchers
154
- - Policy analysts
155
- - Attorneys
156
- - Historians
157
- - Members of the public seeking transparency
158
 
159
  ---
160
 
161
- ## πŸ“¬ Contact / Issues
162
 
163
- This Space is an open, public-interest research tool.
164
- For issues, suggestions, or compliance questions, please use the Hugging Face discussion tab.
 
 
 
 
 
165
 
166
  ---
167
 
168
- ### πŸ›οΈ Transparency First. Public Records Only.
 
 
1
+ # πŸ›οΈ Federal FOIA Intelligence Search
 
 
 
 
 
 
 
 
 
 
 
 
 
2
  ### Public Electronic Reading Rooms Only
3
 
4
+ This Hugging Face Space provides **live search access to U.S. Government FOIA documents**
5
+ released through official public Electronic Reading Rooms.
 
6
 
7
  ---
8
 
9
  ## βœ… What This App Does
10
+ - Searches **public FOIA portals** (e.g. FBI Vault, CIA Reading Room)
11
+ - Clearly labels **Live vs Stub** results
12
+ - Allows export **only** for lawfully retrievable documents
13
+ - Requires explicit consent for extended (blocked) agencies
 
 
 
14
 
15
  ---
16
 
17
+ ## πŸ”’ Stub Results (Transparency Only)
 
 
 
 
 
 
 
 
 
 
 
 
18
 
19
+ Some agencies do **not** permit automated access or do not provide public FOIA search endpoints.
 
 
 
 
 
20
 
21
+ These are represented as **stub adapters**:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
22
  - NSA
 
 
23
  - NGA
24
+ - (Others may be added similarly)
 
 
 
 
 
25
 
26
+ Stub results:
27
+ - ❌ Do not perform network requests
28
+ - ❌ Do not retrieve documents
29
+ - ❌ Cannot be exported
30
 
31
+ > ℹ️ Stub results are informational and cannot be exported.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
32
 
33
  ---
34
 
35
+ ## πŸ“€ Export Rules
36
+ Only results from **live public FOIA sources** are exportable.
 
 
 
 
 
 
 
 
 
 
 
37
 
38
  ---
39
 
40
+ ## 🧠 Ethics & Compliance
41
+ - No classified systems accessed
42
+ - No bypassing robots.txt
43
+ - No scraping restricted endpoints
44
+ - No personal data collected
45
+ - Public FOIA releases only
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
46
 
47
  ---
48
 
49
+ ## βœ… FINAL HF REVIEWER RESPONSE
50
 
51
+ > This Space performs automated searches only against U.S. Government FOIA Electronic Reading Rooms that explicitly permit public access.
52
+ >
53
+ > Agencies that block automated access or lack public search endpoints are represented with clearly labeled stub results for transparency only.
54
+ >
55
+ > Stub adapters do not perform network requests and cannot export content.
56
+ >
57
+ > This application indexes only documents lawfully released to the public under FOIA.
58
 
59
  ---
60
 
61
+ ## πŸ“œ Intended Use
62
+ Research, journalism, transparency, and educational use only.