fix "rest_hostname" value for .transifexrc (#83)

Author: shimizukawa

CHANGES.rst

@@ -20,6 +20,11 @@ Documentation
 Bug Fixes
 ---------
 
+- Fixed errors in the ``~/.transifexrc`` file generated by the ``create-transifexrc`` command;
+  the correct value for ``rest_hostname`` is ``https://rest.api.transifex.com``.
+  Note: ``create-transifexrc`` command and ``SPHINXINTL_TRANSIFEX_TOKEN`` have been deprecated.
+  They will be removed after six months. Please use the TX_TOKEN environment variable instead.
+
 2.1.0 (2023/02/05)
 ==================
 

sphinx_intl/commands.py

@@ -9,6 +9,7 @@
 """
 import re
 import os
+import warnings
 from glob import glob
 
 import click
@@ -134,7 +135,7 @@ def convert(self, value, param, ctx):
     '--transifex-token',
     envvar=ENVVAR_PREFIX + '_TRANSIFEX_TOKEN',
     type=str, metavar='<TOKEN>', required=True,
-    help="Your transifex token.")
+    help="Your transifex token. (DEPRECATED)")
 
 option_transifex_organization_name = click.option(
     '--transifex-organization-name',
@@ -300,8 +301,16 @@ def stat(locale_dir, language):
 @option_transifex_token
 def create_transifexrc(transifex_token):
     """
-    Create `$HOME/.transifexrc`
+    Create `$HOME/.transifexrc`  (deprecated)
     """
+    warnings.filterwarnings("default", category=DeprecationWarning)
+    warnings.warn(
+        (
+            "create-transifexrc command and SPHINXINTL_TRANSIFEX_TOKEN "
+            "will be deprecated. Please use TX_TOKEN environment variable instead."
+        ),
+        category=DeprecationWarning,
+    )
     transifex.create_transifexrc(transifex_token)
 
 

sphinx_intl/transifex.py

@@ -29,7 +29,7 @@
 
 TRANSIFEXRC_TEMPLATE = """\
 [https://www.transifex.com]
-rest_hostname = https://www.transifex.com
+rest_hostname = https://rest.api.transifex.com
 token = %(transifex_token)s
 """