Prepare for deprecated distribution names final releases

duncanriach · duncanriach · commit f2ee71a07b27 · 2023-04-27T12:30:22.000-07:00
diff --git a/deprecated/MANIFEST.in b/deprecated/MANIFEST.in
@@ -0,0 +1 @@
+exclude README.md
diff --git a/deprecated/README.md b/deprecated/README.md
@@ -0,0 +1,6 @@
+# Final Releases of Deprecated PyPI Package Names
+
+In this current directory, use the `setup.py` script to complete the release
+(e.g. `python3 setup.py {sdist, bdist_wheel}`, etc), as documented in the
+standard [release procedures](../release_procedure.md), after having set
+`package_name` appropriately in the script (using commenting-in/out).
diff --git a/deprecated/fwd9m/__init__.py b/deprecated/fwd9m/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2020 NVIDIA. All Rights Reserved.
+# Copyright 2023 NVIDIA Corporation. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,7 +17,17 @@
 from __future__ import division
 from __future__ import print_function
 
-from .version import __version__
-from .warning import message
+distribution_name = "framework-determinism"
 
-print(message)
+version = "0.1.0"
+
+long_description = """
+The `framework-determinism` PyPI distribution has been deprecated and the
+`fwd9m` package in this distribution contains no code.
+
+Please install the latest version of the
+[framework-reproducibility](https://pypi.org/project/framework-reproducibility/)
+PyPI distribution.
+"""
+
+print(long_description)
diff --git a/deprecated/setup.py b/deprecated/setup.py
@@ -0,0 +1,49 @@
+# Copyright 2020-2023 NVIDIA Corporation. All Rights Reserved
+#
+# 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
+import setuptools
+
+# package_name = 'fwd9m'
+package_name = 'tfdeterminism'
+
+print("PACKAGE IMPORT WARNING (expected):")
+package = importlib.import_module(package_name)
+
+description = ("Providing reproducibility in deep learning frameworks")
+url = "https://github.com/NVIDIA/%s" % package.distribution_name
+
+print("Now running setuptools.setup()")
+
+# Note that using python 3.6 (i.e. via the `python3.6` executable) results in
+# the long_description_content_type being ignored.
+# For more info, see https://github.com/di/markdown-description-example/issues/4
+
+setuptools.setup(
+  name                          = package.distribution_name,
+  version                       = package.version,
+  packages                      = [package_name],
+  url                           = url,
+  license                       = 'Apache 2.0',
+  author                        = 'NVIDIA',
+  author_email                  = 'duncan@nvidia.com',
+  description                   = description,
+  long_description              = package.long_description,
+  long_description_content_type = 'text/markdown',
+  install_requires              = [],
+  classifiers                   = [],
+  keywords                      = [],
+  platforms                     = []
+)
diff --git a/deprecated/tfdeterminism/__init__.py b/deprecated/tfdeterminism/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2020 NVIDIA Corporation. All Rights Reserved
+# Copyright 2023 NVIDIA Corporation. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,16 +13,21 @@
 # limitations under the License.
 # ========================================================================
 
-message = """
-WARNING:
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import print_function
 
-framework-determinism version 0.0.0 is a placeholder distribution that is
-intended only to reserve the distribution name in the Python Package Index
-(PyPI).
+distribution_name = "tensorflow-determinism"
 
-The fwrepro package has not yet been populated in this PyPI distribution.
-Install a newer version of this distribution (if one now exists) or install the
-latest version of the tensorflow-determinism PyPI distribution, which is the
-distribution that will evolve (or has evolved) into the framework-determinism
+version = "0.4.0"
+
+long_description = """
+The `tensorflow-determinism` PyPI distribution has been deprecated and the
+`tfdeterminism` package in this distribution contains no code.
+
+Please install the latest version of the
+[framework-reproducibility](https://pypi.org/project/framework-reproducibility/)
 PyPI distribution.
 """
+
+print(long_description)
diff --git a/fwd9m_reserve/version.py b/fwd9m_reserve/version.py
diff --git a/fwr13y/__init__.py b/fwr13y/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2020 NVIDIA. All Rights Reserved.
+# Copyright 2020 NVIDIA Corporation. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
diff --git a/fwr13y/d9m/__init__.py b/fwr13y/d9m/__init__.py
@@ -1,4 +1,4 @@
-# Copyright 2022 NVIDIA. All Rights Reserved.
+# Copyright 2022 NVIDIA Corporation. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
diff --git a/release_procedure.md b/release_procedure.md
@@ -52,7 +52,7 @@ are to be excluded from the distribution (e.g. via `MANIFEST.in` or the
 `python3 setup.py sdist`, otherwise the exluded items will remain.
 
 Note that to install the source distribution, the user will need to have `pip`
-installed a new-enough version of `setuptools` and also `wheel`.
+installed, a new-enough version of `setuptools` and also `wheel`.
 
 ## 6. Create a Universal Wheel
 
@@ -112,6 +112,19 @@ venv/bin/pip install -i https://test.pypi.org/pypi/ framework-reproducibility
 rm -rf venv
 ```
 
+A couple of notes related to the PyPI server functionality, as observed from
+playing with the test server:
+
+1. You have to upload the source distribution (the `.tar.gz` file) before the
+wheel in order for the description to be intepreted as markdown. Presumably,
+the source format is not been into the wheel, at least in the way it's created
+here, and once it's been set for a given version it cannot be changed.
+
+2. It can take a few minutes for the versioning seen by `pip` to be updated. So
+waiting for a few minutes can resolve issues where it seems that the latest
+version is not yet available to install, even though you can see it should be
+availble according to the web page for the distribution.
+
 ### 7b. Real PyPI Server
 
 ```
diff --git a/setup.py b/setup.py
@@ -17,7 +17,6 @@
 import os
 
 distribution_name = 'framework-reproducibility'
-# package_name = 'fwrepro' + '_reserve'
 package_name = 'fwr13y'
 
 # This file needs to be executed during installation. It's not possible to
@@ -27,12 +26,8 @@
 import sys
 sys.path.append(package_name)
 from version import __version__ as version
-# from warning import message as warning_message
 sys.path.remove(package_name)
 
-# if warning_message:
-#   long_description = warning_message
-# else:
 readme = os.path.join(os.path.dirname(os.path.realpath(__file__)),
                       "pypi_description.md")
 with open(readme, "r") as fp:
@@ -55,18 +50,10 @@
             "variance-reduction atomics ngc gpu-determinism deterministic-ops "
             "frameworks gpu-support d9m r13y fwr13y")
 
-# `find_packages(exclude=['fwd9m_reserve'])` is used instead of adding
-# `exclude fwd9m_reserve/*` to `MANIFEST.in` because even though `MANIFEST.in`
-# is attended to in the creation of the source distribution, it is ignored in
-# the creation of the wheel. Folks generally seem to think that
-# `include_package_data=True` is needed to make the exclusions from the contents
-# of the wheel match those of the source distribution, but it doesn't seem to
-# make any difference.
-
 setup(
   name                          = distribution_name,
   version                       = version,
-  packages                      = find_packages(exclude=['fwd9m_reserve']),
+  packages                      = ['fwr13y'],
   url                           = url,
   license                       = 'Apache 2.0',
   author                        = 'NVIDIA',

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Copyright 2020 NVIDIA. All Rights Reserved.`
	`1`	`+# Copyright 2020 NVIDIA Corporation. All Rights Reserved.`
`2`	`2`	`#`
`3`	`3`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`# you may not use this file except in compliance with the License.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Copyright 2022 NVIDIA. All Rights Reserved.`
	`1`	`+# Copyright 2022 NVIDIA Corporation. All Rights Reserved.`
`2`	`2`	`#`
`3`	`3`	`# Licensed under the Apache License, Version 2.0 (the "License");`
`4`	`4`	`# you may not use this file except in compliance with the License.`