thadillo Claude commited on
Commit
67d3f72
·
1 Parent(s): 18bfe26

Add copyright and attribution for Marcos Thadeu Queiroz Magalhães

Browse files

This commit adds comprehensive copyright and attribution information
throughout the codebase as requested by the author.

Changes:
- Created LICENSE file (MIT License with attribution requirement)
- Created CITATION.cff for academic citations
- Created CREDITS.md with detailed attribution guidelines
- Added copyright notices to README.md and README_HF.md
- Added copyright headers to main code files:
- app/__init__.py
- app/analyzer.py
- app_hf.py

Attribution Requirement:
This software must be cited and credited to Marcos Thadeu Queiroz Magalhães
(thadillo@gmail.com) whenever used or employed in any capacity.

This includes:
- Source code and documentation
- Academic publications and presentations
- Derivative works and commercial applications
- User interfaces and credits sections

Author: Marcos Thadeu Queiroz Magalhães
Email: thadillo@gmail.com
Copyright: © 2024-2025 All rights reserved

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

Files changed (8) hide show
  1. CITATION.cff +36 -0
  2. CREDITS.md +127 -0
  3. LICENSE +33 -0
  4. README.md +28 -3
  5. README_HF.md +6 -1
  6. app/__init__.py +6 -0
  7. app/analyzer.py +3 -0
  8. app_hf.py +3 -0
CITATION.cff ADDED
@@ -0,0 +1,36 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ cff-version: 1.2.0
2
+ message: "If you use this software, please cite it as below."
3
+ type: software
4
+ title: "Participatory Planning Application"
5
+ abstract: "An AI-powered collaborative urban planning platform for multi-stakeholder engagement sessions with advanced sentence-level categorization and fine-tuning capabilities."
6
+ authors:
7
+ - family-names: "Magalhães"
8
+ given-names: "Marcos Thadeu Queiroz"
9
+ email: "thadillo@gmail.com"
10
+ orcid: ""
11
+ alias: "thadillo"
12
+ repository-code: "https://github.com/thadillo/participatory-planner"
13
+ url: "https://huggingface.co/spaces/thadillo/participatory-planner"
14
+ license: MIT
15
+ keywords:
16
+ - "participatory planning"
17
+ - "urban planning"
18
+ - "AI classification"
19
+ - "stakeholder engagement"
20
+ - "zero-shot learning"
21
+ - "fine-tuning"
22
+ - "natural language processing"
23
+ - "community engagement"
24
+ version: 1.0.0
25
+ date-released: 2025-10-15
26
+ preferred-citation:
27
+ type: software
28
+ title: "Participatory Planning Application"
29
+ authors:
30
+ - family-names: "Magalhães"
31
+ given-names: "Marcos Thadeu Queiroz"
32
+ email: "thadillo@gmail.com"
33
+ year: 2025
34
+ repository-code: "https://github.com/thadillo/participatory-planner"
35
+ license: MIT
36
+ abstract: "An AI-powered collaborative urban planning platform for multi-stakeholder engagement sessions with advanced sentence-level categorization and fine-tuning capabilities using Hugging Face transformers."
CREDITS.md ADDED
@@ -0,0 +1,127 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Credits and Attribution
2
+
3
+ ## Author
4
+
5
+ **Marcos Thadeu Queiroz Magalhães**
6
+ - Email: thadillo@gmail.com
7
+ - GitHub: [@thadillo](https://github.com/thadillo)
8
+ - HuggingFace: [@thadillo](https://huggingface.co/thadillo)
9
+
10
+ ## Copyright
11
+
12
+ Copyright © 2024-2025 Marcos Thadeu Queiroz Magalhães
13
+
14
+ All rights reserved.
15
+
16
+ ## License
17
+
18
+ This software is licensed under the MIT License. See [LICENSE](LICENSE) file for full details.
19
+
20
+ ## Citation Requirement
21
+
22
+ **This software must be cited and credited to Marcos Thadeu Queiroz Magalhães whenever used or employed in any capacity.**
23
+
24
+ ### How to Cite
25
+
26
+ #### In Academic Publications
27
+
28
+ ```bibtex
29
+ @software{magalhaes2025participatory,
30
+ author = {Magalhães, Marcos Thadeu Queiroz},
31
+ title = {Participatory Planning Application},
32
+ year = {2025},
33
+ url = {https://github.com/thadillo/participatory-planner},
34
+ license = {MIT}
35
+ }
36
+ ```
37
+
38
+ #### In Software/Applications
39
+
40
+ ```
41
+ Participatory Planning Application
42
+ Copyright (c) 2024-2025 Marcos Thadeu Queiroz Magalhães (thadillo@gmail.com)
43
+ Licensed under MIT License
44
+ https://github.com/thadillo/participatory-planner
45
+ ```
46
+
47
+ #### In Documentation
48
+
49
+ ```markdown
50
+ This project uses the Participatory Planning Application by
51
+ Marcos Thadeu Queiroz Magalhães (thadillo@gmail.com).
52
+ ```
53
+
54
+ ## Attribution Requirements
55
+
56
+ When using this software, you must include attribution in:
57
+
58
+ 1. **Source Code**
59
+ - Copyright headers in modified or derivative files
60
+ - README or documentation files
61
+ - License notices
62
+
63
+ 2. **User Interfaces**
64
+ - About/Credits section
65
+ - Help documentation
66
+ - Startup screens (where applicable)
67
+
68
+ 3. **Academic Publications**
69
+ - References/Bibliography section
70
+ - Acknowledgments section
71
+ - Methods section (when describing the tool)
72
+
73
+ 4. **Commercial Applications**
74
+ - Product documentation
75
+ - Credits section
76
+ - Legal notices
77
+
78
+ ## Third-Party Dependencies
79
+
80
+ This software builds upon excellent open-source projects:
81
+
82
+ ### Core Framework
83
+ - **Flask** - Web framework (BSD-3-Clause License)
84
+ - **SQLAlchemy** - Database ORM (MIT License)
85
+
86
+ ### AI/ML Components
87
+ - **Hugging Face Transformers** - NLP models (Apache 2.0 License)
88
+ - **PyTorch** - Machine learning framework (BSD-3-Clause License)
89
+ - **PEFT** - Parameter-Efficient Fine-Tuning (Apache 2.0 License)
90
+
91
+ ### Frontend Libraries
92
+ - **Bootstrap 5** - UI framework (MIT License)
93
+ - **Leaflet.js** - Interactive maps (BSD-2-Clause License)
94
+ - **Chart.js** - Data visualization (MIT License)
95
+
96
+ ### Utilities
97
+ - **python-dotenv** - Environment configuration (BSD-3-Clause License)
98
+ - **Flask-Limiter** - Rate limiting (MIT License)
99
+
100
+ All third-party dependencies retain their original licenses and copyrights.
101
+
102
+ ## Pre-trained Models
103
+
104
+ This application uses the following pre-trained AI models:
105
+
106
+ - **facebook/bart-large-mnli** - Meta AI (MIT License)
107
+ - **MoritzLaurer/DeBERTa-v3-base-mnli-fever-anli** - Moritz Laurer (MIT License)
108
+ - **valhalla/distilbart-mnli-12-3** - Valhalla (Apache 2.0 License)
109
+
110
+ These models are used for zero-shot classification and are not modified by this software.
111
+
112
+ ## Acknowledgments
113
+
114
+ Special thanks to:
115
+ - The Hugging Face team for their excellent transformers library
116
+ - The Flask community for a robust web framework
117
+ - All open-source contributors whose work made this project possible
118
+
119
+ ## Questions?
120
+
121
+ For questions about attribution, licensing, or usage:
122
+ - Email: thadillo@gmail.com
123
+ - GitHub Issues: https://github.com/thadillo/participatory-planner/issues
124
+
125
+ ---
126
+
127
+ **Remember**: Proper attribution is not just a legal requirement—it's a way to acknowledge the work and effort that went into creating this software. Thank you for respecting the license and citing this work appropriately.
LICENSE ADDED
@@ -0,0 +1,33 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ MIT License
2
+
3
+ Copyright (c) 2024-2025 Marcos Thadeu Queiroz Magalhães (thadillo@gmail.com)
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ ATTRIBUTION REQUIREMENT:
16
+ Any use, modification, or distribution of this Software must include proper
17
+ attribution to the original author:
18
+ Marcos Thadeu Queiroz Magalhães (thadillo@gmail.com)
19
+
20
+ This attribution must be included in:
21
+ - Source code files (as comments or headers)
22
+ - Documentation
23
+ - User interfaces (where applicable)
24
+ - Academic publications or presentations using this software
25
+ - Derivative works
26
+
27
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
30
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
31
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
32
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33
+ SOFTWARE.
README.md CHANGED
@@ -12,6 +12,15 @@ license: mit
12
 
13
  An AI-powered collaborative urban planning platform for multi-stakeholder engagement sessions with advanced sentence-level categorization and fine-tuning capabilities.
14
 
 
 
 
 
 
 
 
 
 
15
  ## Features
16
 
17
  ### Core Features
@@ -242,18 +251,34 @@ ZERO_SHOT_MODELS_DIR=models/zero_shot
242
 
243
  ## License
244
 
245
- MIT - See LICENSE file for details
 
 
 
 
 
 
 
 
 
 
 
 
 
 
246
 
247
  ## Contributing
248
 
249
  Contributions welcome! Please:
250
  1. Fork the repository
251
  2. Create a feature branch
252
- 3. Submit a pull request with clear description
 
253
 
254
  ## Support
255
 
256
  For issues or questions:
257
  1. Check existing documentation files
258
  2. Review troubleshooting section above
259
- 3. Open an issue with detailed description
 
 
12
 
13
  An AI-powered collaborative urban planning platform for multi-stakeholder engagement sessions with advanced sentence-level categorization and fine-tuning capabilities.
14
 
15
+ ## Author & Copyright
16
+
17
+ **Created by: Marcos Thadeu Queiroz Magalhães**
18
+ 📧 thadillo@gmail.com
19
+
20
+ Copyright © 2024-2025 Marcos Thadeu Queiroz Magalhães. All rights reserved.
21
+
22
+ This software must be cited and credited to Marcos Thadeu Queiroz Magalhães whenever used or employed in any capacity.
23
+
24
  ## Features
25
 
26
  ### Core Features
 
251
 
252
  ## License
253
 
254
+ MIT License - See [LICENSE](LICENSE) file for full details.
255
+
256
+ Copyright © 2024-2025 Marcos Thadeu Queiroz Magalhães (thadillo@gmail.com)
257
+
258
+ ### Citation Requirement
259
+
260
+ Any use, modification, or distribution of this software must include proper attribution to:
261
+
262
+ **Marcos Thadeu Queiroz Magalhães (thadillo@gmail.com)**
263
+
264
+ This includes:
265
+ - Source code and documentation
266
+ - Academic publications or presentations
267
+ - Derivative works and commercial applications
268
+ - User interfaces and credits sections
269
 
270
  ## Contributing
271
 
272
  Contributions welcome! Please:
273
  1. Fork the repository
274
  2. Create a feature branch
275
+ 3. Maintain attribution to the original author in all contributions
276
+ 4. Submit a pull request with clear description
277
 
278
  ## Support
279
 
280
  For issues or questions:
281
  1. Check existing documentation files
282
  2. Review troubleshooting section above
283
+ 3. Contact: thadillo@gmail.com
284
+ 4. Open an issue with detailed description
README_HF.md CHANGED
@@ -12,6 +12,9 @@ license: mit
12
 
13
  An AI-powered collaborative urban planning platform for multi-stakeholder engagement sessions.
14
 
 
 
 
15
  ## Features
16
 
17
  - 🎯 **Token-based access** - Self-service registration for participants
@@ -53,4 +56,6 @@ The app starts empty. You can:
53
 
54
  ## License
55
 
56
- MIT
 
 
 
12
 
13
  An AI-powered collaborative urban planning platform for multi-stakeholder engagement sessions.
14
 
15
+ **Created by: Marcos Thadeu Queiroz Magalhães** (thadillo@gmail.com)
16
+ Copyright © 2024-2025. All rights reserved.
17
+
18
  ## Features
19
 
20
  - 🎯 **Token-based access** - Self-service registration for participants
 
56
 
57
  ## License
58
 
59
+ MIT License - Copyright © 2024-2025 Marcos Thadeu Queiroz Magalhães (thadillo@gmail.com)
60
+
61
+ This software must be cited and credited to Marcos Thadeu Queiroz Magalhães whenever used or employed.
app/__init__.py CHANGED
@@ -1,3 +1,9 @@
 
 
 
 
 
 
1
  from flask import Flask
2
  from flask_sqlalchemy import SQLAlchemy
3
  from flask_limiter import Limiter
 
1
+ """
2
+ Participatory Planning Application
3
+ Copyright (c) 2024-2025 Marcos Thadeu Queiroz Magalhães (thadillo@gmail.com)
4
+ Licensed under MIT License - See LICENSE file for details
5
+ """
6
+
7
  from flask import Flask
8
  from flask_sqlalchemy import SQLAlchemy
9
  from flask_limiter import Limiter
app/analyzer.py CHANGED
@@ -2,6 +2,9 @@
2
  AI-powered submission analyzer using Hugging Face zero-shot classification.
3
  This module provides free, offline classification without requiring API keys.
4
  Supports both base models and fine-tuned models with LoRA.
 
 
 
5
  """
6
 
7
  from transformers import pipeline, AutoTokenizer, AutoModelForSequenceClassification
 
2
  AI-powered submission analyzer using Hugging Face zero-shot classification.
3
  This module provides free, offline classification without requiring API keys.
4
  Supports both base models and fine-tuned models with LoRA.
5
+
6
+ Copyright (c) 2024-2025 Marcos Thadeu Queiroz Magalhães (thadillo@gmail.com)
7
+ Licensed under MIT License - See LICENSE file for details
8
  """
9
 
10
  from transformers import pipeline, AutoTokenizer, AutoModelForSequenceClassification
app_hf.py CHANGED
@@ -1,6 +1,9 @@
1
  """
2
  Hugging Face Spaces entry point
3
  This wraps the Flask app for Hugging Face deployment
 
 
 
4
  """
5
  import os
6
  import sys
 
1
  """
2
  Hugging Face Spaces entry point
3
  This wraps the Flask app for Hugging Face deployment
4
+
5
+ Copyright (c) 2024-2025 Marcos Thadeu Queiroz Magalhães (thadillo@gmail.com)
6
+ Licensed under MIT License - See LICENSE file for details
7
  """
8
  import os
9
  import sys