Skip to content

docs: add NOTICE copyright file#117

Merged
bobbui merged 1 commit into
bobbui:masterfrom
rednikisfun:docs-93-notice-file
Jun 17, 2026
Merged

docs: add NOTICE copyright file#117
bobbui merged 1 commit into
bobbui:masterfrom
rednikisfun:docs-93-notice-file

Conversation

@rednikisfun

@rednikisfun rednikisfun commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds a NOTICE file with a project copyright notice for json-logging-python.
  • Includes NOTICE in MANIFEST.in so source distributions ship it.
  • Updates setup.cfg license metadata so both LICENSE and NOTICE are treated as license files.

Fixes #93

Verification

  • python setup.py check -m -s
  • python setup.py sdist --dist-dir /tmp/json-logging-python-sdist
  • tar -tzf /tmp/json-logging-python-sdist/json_logging-1.5.1.tar.gz | grep '/NOTICE$'\n- python -m pytest --ignore tests/smoketests\n\n## Notes\n- The copyright year is based on the first commit year referenced in the issue and confirmed from git history.

Summary by CodeRabbit

  • Chores
    • Updated source distribution configuration to include an attribution notice file in package builds.

@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b291640e-7105-438f-a3c2-073b3a742aad

📥 Commits

Reviewing files that changed from the base of the PR and between 630596a and 7db0472.

📒 Files selected for processing (3)
  • MANIFEST.in
  • NOTICE
  • setup.cfg

📝 Walkthrough

Walkthrough

A new NOTICE file is introduced with attribution text for the json-logging-python project. MANIFEST.in is updated to include NOTICE in source distributions, and setup.cfg replaces the single license_file entry with a license_files list covering both LICENSE and NOTICE.

Changes

NOTICE file and distribution wiring

Layer / File(s) Summary
NOTICE file content and packaging registration
NOTICE, setup.cfg, MANIFEST.in
NOTICE is created with attribution text identifying json-logging-python; setup.cfg replaces license_file=LICENSE with a license_files multi-entry list of LICENSE and NOTICE; MANIFEST.in adds NOTICE to the sdist include list.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇 A NOTICE now hops into the tree,
With credits and names for all to see.
The MANIFEST tucks it in just right,
setup.cfg shines an attribution light.
No copyright shall wander free! 🥕

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add NOTICE copyright file' accurately describes the main change - adding a NOTICE copyright file to the project.
Linked Issues check ✅ Passed All requirements from issue #93 are met: a NOTICE file was created with copyright information, MANIFEST.in includes the NOTICE file, and setup.cfg designates both LICENSE and NOTICE as license files.
Out of Scope Changes check ✅ Passed All changes are directly related to adding the copyright notice file and updating build configuration - no out-of-scope modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a new NOTICE file containing copyright information, updates MANIFEST.in to include it, and configures setup.cfg to package both LICENSE and NOTICE files. I have no feedback to provide as the changes are straightforward and correct.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

@qodo-code-review

Copy link
Copy Markdown

PR Summary by Qodo

Add NOTICE file and include it in packaging metadata
📝 Documentation ⚙️ Configuration changes 🕐 Less than 10 minutes

Grey Divider

Description

• Add a project NOTICE file with copyright and attribution text.
• Include NOTICE in sdist via MANIFEST.in.
• Update setuptools metadata so LICENSE and NOTICE are treated as license files.
Diagram

graph TD
  A["setup.cfg"] --> B["setuptools metadata"] --> C["sdist build"] --> D["Source tarball"]
  E["MANIFEST.in"] --> C
  F["NOTICE"] --> E
Loading
High-Level Assessment

The approach is the standard setuptools way to ship and declare license-related files: add NOTICE, include it in MANIFEST.in for sdists, and list it under metadata. Considered keeping the legacy license_file field, but license_files is the modern, multi-file-compatible option and fits this change.

Files changed (3) +10 / -3

Documentation (1) +5 / -0
NOTICEAdd project NOTICE attribution file +5/-0

Add project NOTICE attribution file

• Introduces a NOTICE file containing project copyright and attribution text for downstream redistribution.

NOTICE

Other (2) +5 / -3
MANIFEST.inInclude NOTICE in the sdist manifest +1/-1

Include NOTICE in the sdist manifest

• Adds the new NOTICE file to the include list so it is shipped in source distributions.

MANIFEST.in

setup.cfgDeclare LICENSE and NOTICE as license files +4/-2

Declare LICENSE and NOTICE as license files

• Replaces the single-file license_file setting with license_files listing both LICENSE and NOTICE so packaging tools recognize them.

setup.cfg

@llamapreview llamapreview Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Auto Pull Request Review from LlamaPReview

Review Status: Automated Review Skipped

Dear contributor,

Thank you for your Pull Request. LlamaPReview has analyzed your changes and determined that this PR does not require an automated code review.

Analysis Result:

PR contains only documentation updates (adding a NOTICE file) and configuration changes (updating MANIFEST.in and setup.cfg), requiring no automated code review

We're continuously improving our PR analysis capabilities. Have thoughts on when and how LlamaPReview should perform automated reviews? Share your insights in our GitHub Discussions.

Best regards,
LlamaPReview Team

@qodo-code-review

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Qodo Logo

@bobbui bobbui merged commit 9dc550d into bobbui:master Jun 17, 2026
11 checks passed
@bobbui

bobbui commented Jun 17, 2026

Copy link
Copy Markdown
Owner

thanks for you contribution

@Exagone313

Copy link
Copy Markdown
Contributor

@bobbui Hello, this doesn't feel right to accept AI contributions like this.

The NOTICE file does not contain the license placeholder:

json-logging-python/LICENSE

Lines 190 to 202 in ac68fce

Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

@rednikisfun

Copy link
Copy Markdown
Contributor Author

Thanks for flagging this. You are right: the merged NOTICE used custom attribution wording rather than the Apache appendix notice form.

I opened #119 to correct the NOTICE text while keeping the packaging metadata from #117 intact.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing copyright notice

3 participants