Skip to content

Commit

Permalink
docs: clean-up headers to ease maintenance + add funding
Browse files Browse the repository at this point in the history
  • Loading branch information
BoboTiG committed Aug 14, 2024
1 parent 324e044 commit 80576b4
Show file tree
Hide file tree
Showing 46 changed files with 59 additions and 610 deletions.
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
github: [BoboTiG]
polar: tiger-222
6 changes: 4 additions & 2 deletions COPYING
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Copyright 2011 Yesudeep Mangalapilly <[email protected]>
Copyright 2012 Google, Inc & contributors.
Copyright 2018-2024 Mickaël Schoentgen & contributors
Copyright 2014-2018 Thomas Amland & contributors
Copyright 2012-2014 Google, Inc.
Copyright 2011-2012 Yesudeep Mangalapilly

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
7 changes: 4 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,9 +220,10 @@ Licensing

Watchdog is licensed under the terms of the `Apache License, version 2.0`_.

Copyright 2011 `Yesudeep Mangalapilly`_.

Copyright 2012 Google, Inc & contributors.
- Copyright 2018-2024 Mickaël Schoentgen & contributors
- Copyright 2014-2018 Thomas Amland & contributors
- Copyright 2012-2014 Google, Inc.
- Copyright 2011-2012 Yesudeep Mangalapilly

Project `source code`_ is available at Github. Please report bugs and file
enhancement requests at the `issue tracker`_.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import watchdog.version # noqa: E402

PROJECT_NAME = "watchdog"
AUTHOR_NAME = "Yesudeep Mangalapilly and contributors"
AUTHOR_NAME = "Yesudeep Mangalapilly, Mickaël Schoentgen, and contributors"
COPYRIGHT = f"2010-2024, {AUTHOR_NAME}"


Expand Down
6 changes: 3 additions & 3 deletions docs/source/global.rst.inc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. Global includes, substitutions, and common links.

.. |author_name| replace:: Yesudeep Mangalapilly
.. |author_email| replace:: [email protected]
.. |copyright| replace:: Copyright 2012-2024 Google, Inc & contributors.
.. |author_name| replace:: Mickaël Schoentgen
.. |author_email| replace:: contact@tiger-222.fr
.. |copyright| replace:: Copyright 2011-2024 Yesudeep Mangalapilly, Mickaël Schoentgen & contributors.
.. |project_name| replace:: ``watchdog``
.. |project_version| replace:: 5.0.0

Expand Down
19 changes: 2 additions & 17 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
#
# 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.

import importlib.util
import sys
import os
Expand Down Expand Up @@ -91,8 +76,8 @@
description="Filesystem events monitoring",
long_description=readme + "\n\n" + changelog,
long_description_content_type="text/x-rst",
author="Yesudeep Mangalapilly",
author_email="[email protected]",
author="Mickaël Schoentgen",
author_email="[email protected]",
license="Apache-2.0",
url="https://github.com/gorakhargosh/watchdog",
keywords=" ".join(
Expand Down
14 changes: 0 additions & 14 deletions src/watchdog/__init__.py
Original file line number Diff line number Diff line change
@@ -1,14 +0,0 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
#
# 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.
15 changes: 0 additions & 15 deletions src/watchdog/events.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
#
# 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.

""":module: watchdog.events
:synopsis: File system events and event handlers.
:author: [email protected] (Yesudeep Mangalapilly)
Expand Down
17 changes: 1 addition & 16 deletions src/watchdog/observers/__init__.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
#
# 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.

""":module: watchdog.observers
:synopsis: Observer that picks a native implementation if available.
:author: [email protected] (Yesudeep Mangalapilly)
Expand All @@ -37,7 +22,7 @@
|Inotify| Linux 2.6.13+ ``inotify(7)`` based observer
|FSEvents| macOS FSEvents based observer
|Kqueue| macOS and BSD with kqueue(2) ``kqueue(2)`` based observer
|WinApi| MS Windows Windows API-based observer
|WinApi| Microsoft Windows Windows API-based observer
|Polling| Any fallback implementation
============== ================================ ==============================
Expand Down
15 changes: 0 additions & 15 deletions src/watchdog/observers/api.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
#
# 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.

from __future__ import annotations

import contextlib
Expand Down
15 changes: 0 additions & 15 deletions src/watchdog/observers/fsevents.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
#
# 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.

""":module: watchdog.observers.fsevents
:synopsis: FSEvents based emitter implementation.
:author: [email protected] (Yesudeep Mangalapilly)
Expand Down
16 changes: 2 additions & 14 deletions src/watchdog/observers/fsevents2.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,7 @@
# Copyright 2014 Thomas Amland <[email protected]>
#
# 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.

""":module: watchdog.observers.fsevents2
:synopsis: FSEvents based emitter implementation.
:author: [email protected] (Thomas Amland)
:author: [email protected] (Mickaël Schoentgen)
:platforms: macOS
"""

Expand Down
16 changes: 1 addition & 15 deletions src/watchdog/observers/inotify.py
Original file line number Diff line number Diff line change
@@ -1,24 +1,10 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
#
# 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.

""":module: watchdog.observers.inotify
:synopsis: ``inotify(7)`` based emitter implementation.
:author: Sebastien Martini <[email protected]>
:author: Luke McCarthy <[email protected]>
:author: [email protected] (Yesudeep Mangalapilly)
:author: Tim Cuthbertson <[email protected]>
:author: [email protected] (Mickaël Schoentgen)
:platforms: Linux 2.6.13+.
.. ADMONITION:: About system requirements
Expand Down
19 changes: 6 additions & 13 deletions src/watchdog/observers/inotify_buffer.py
Original file line number Diff line number Diff line change
@@ -1,16 +1,9 @@
# Copyright 2014 Thomas Amland <[email protected]>
#
# 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.
""":module: watchdog.observers.inotify_buffer
:synopsis: A wrapper for ``Inotify``.
:author: [email protected] (Thomas Amland)
:author: [email protected] (Mickaël Schoentgen)
:platforms: linux
"""

from __future__ import annotations

Expand Down
15 changes: 0 additions & 15 deletions src/watchdog/observers/inotify_c.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
#
# 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.

from __future__ import annotations

import contextlib
Expand Down
15 changes: 0 additions & 15 deletions src/watchdog/observers/kqueue.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
#
# 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.

""":module: watchdog.observers.kqueue
:synopsis: ``kqueue(2)`` based emitter implementation.
:author: [email protected] (Yesudeep Mangalapilly)
Expand Down
16 changes: 0 additions & 16 deletions src/watchdog/observers/polling.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,3 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
#
# 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.


""":module: watchdog.observers.polling
:synopsis: Polling emitter implementation.
:author: [email protected] (Yesudeep Mangalapilly)
Expand Down
16 changes: 0 additions & 16 deletions src/watchdog/observers/read_directory_changes.py
Original file line number Diff line number Diff line change
@@ -1,19 +1,3 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
# Copyright 2014 Thomas Amland
#
# 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.

from __future__ import annotations

import os.path
Expand Down
45 changes: 10 additions & 35 deletions src/watchdog/observers/winapi.py
Original file line number Diff line number Diff line change
@@ -1,38 +1,13 @@
# winapi.py: Windows API-Python interface (removes dependency on pywin32)
#
# Copyright (C) 2007 Thomas Heller <[email protected]>
# Copyright (C) 2010 Will McGugan <[email protected]>
# Copyright (C) 2010 Ryan Kelly <[email protected]>
# Copyright (C) 2010 Yesudeep Mangalapilly <[email protected]>
# Copyright (C) 2014 Thomas Amland
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and / or other materials provided with the distribution.
# * Neither the name of the organization nor the names of its contributors may
# be used to endorse or promote products derived from this software without
# specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
#
# Portions of this code were taken from pyfilesystem, which uses the above
# new BSD license.
""":module: watchdog.observers.winapi
:synopsis: Windows API-Python interface (removes dependency on ``pywin32``).
:author: [email protected] (Thomas Heller)
:author: [email protected] (Will McGugan)
:author: [email protected] (Ryan Kelly)
:author: [email protected] (Yesudeep Mangalapilly)
:author: [email protected] (Thomas Amland)
:author: [email protected] (Mickaël Schoentgen)
:platforms: windows
"""

from __future__ import annotations

Expand Down
15 changes: 0 additions & 15 deletions src/watchdog/tricks/__init__.py
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# Copyright 2011 Yesudeep Mangalapilly <[email protected]>
# Copyright 2012 Google, Inc & contributors.
#
# 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.

""":module: watchdog.tricks
:synopsis: Utility event handlers.
:author: [email protected] (Yesudeep Mangalapilly)
Expand Down
Loading

0 comments on commit 80576b4

Please sign in to comment.