Minor edits (#162)

* doc : email changed to [email protected] * doc : website changed to pyrgg.site * doc : TOC removed from README.md * doc : badges text-decoration bug fixed * doc : AUTHORS.md updated * doc : CHANGELOG.md updated * doc : donate section added to README.md * fix : fix macOS version to 13 * doc : CHANGELOG.md updated * doc : minor edit in README.md titles * doc : TODO.md removed * doc : branch changed to master in README.md link
sepandhaghighi · Apr 25, 2024 · 2f6c90d · 2f6c90d
1 parent 26836aa
commit 2f6c90d
Show file tree

Hide file tree

Showing 12 changed files with 26 additions and 114 deletions.
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at info@pyrgg.ir. All
+reported by contacting the project team at info@pyrgg.site. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.

diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1 +1 @@
-custom: https://www.pyrgg.ir/donate.html
+custom: https://www.pyrgg.site/donate.html
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -15,7 +15,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-20.04, windows-2022, macOS-12]
+        os: [ubuntu-20.04, windows-2022, macOS-13]
         python-version: [3.5, 3.6, 3.7, 3.8, 3.9, 3.10.0, 3.11.0, 3.12.0]
     steps:
     - uses: actions/checkout@v2

diff --git a/AUTHORS.md b/AUTHORS.md
@@ -1,10 +1,10 @@
-# Core Developers #
+# Core Developers
 
 ----------
-- Sepand Haghighi - Sharif University of Technology - ([@sepandhaghighi](http://github.com/sepandhaghighi)) ([[email protected]](mailto:[email protected]))
-- Sadra Sabouri - Sharif University of Technology - ([@sadrasabouri](https://github.com/sadrasabouri)) ([[email protected]](mailto:[email protected]))
+- Sepand Haghighi - Open Science Laboratory ([Github](https://github.com/sepandhaghighi))
+- Sadra Sabouri - Open Science Laboratory ([Github](https://github.com/sadrasabouri))
 
-# Other Contributors #
+# Other Contributors
 ----------
-- [ivanovmg](https://github.com/ivanovmg)
-- Ahmad Salimi - Sharif University of Technology ([@ahmadsalimi](https://github.com/ahmadsalimi)) ([[email protected]](mailto:[email protected]))
+- [@ivanovmg](https://github.com/ivanovmg)
+- [@ahmadsalimi](https://github.com/ahmadsalimi)
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - `_update_using_first_menu` function changed to `_update_using_menu`
 - `_update_using_second_menu` function changed to `_update_with_engine_params`
 - `ITEM_CONVERTORS` renamed to `ITEM_HANDLERS`
+- Website domain changed to [https://www.pyrgg.site](https://www.pyrgg.site)
 ### Removed
 - `dimacs_init` function
 ## [1.4] - 2023-07-06

diff --git a/README.md b/README.md
@@ -1,43 +1,13 @@
 <div align="center">
 	<img src="https://github.com/sepandhaghighi/pyrgg/raw/master/otherfile/logo.png" width="450">
 	<h1>PyRGG: Python Random Graph Generator</h1>
-	<a href="http://www.shaghighi.ir/pyrgg">
-		<img src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=website">
-	</a>
-	<a href="https://badge.fury.io/py/pyrgg">
-		<img src="https://badge.fury.io/py/pyrgg.svg" alt="PyPI version" height="18">
-	</a>
-	<a href="https://anaconda.org/sepandhaghighi/pyrgg">
-		<img src="https://anaconda.org/sepandhaghighi/pyrgg/badges/version.svg">
-	</a>
-	<a href="https://codecov.io/gh/sepandhaghighi/pyrgg">
-  		<img src="https://codecov.io/gh/sepandhaghighi/pyrgg/branch/master/graph/badge.svg" alt="Codecov">
-	</a>
-	<a href="https://www.python.org/">
-		<img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3">
-	</a>
-	<a href="https://discord.gg/dfYAWVMaCW">
-  		<img src="https://img.shields.io/discord/1013411447130308669.svg" alt="Discord Channel">
-	</a>
-</div>	
-
-## Table of Contents					
-   * [Overview](https://github.com/sepandhaghighi/pyrgg#overview)
-   * [Installation](https://github.com/sepandhaghighi/pyrgg#installation)
-   * [Usage](https://github.com/sepandhaghighi/pyrgg#usage)
-   * [Supported Formats](https://github.com/sepandhaghighi/pyrgg#supported-formats)
-   * [Example of Usage](https://github.com/sepandhaghighi/pyrgg#example-of-usage)
-   * [Similar Works](https://github.com/sepandhaghighi/pyrgg#similar-works)
-   * [Issues & Bug Reports](https://github.com/sepandhaghighi/pyrgg#issues--bug-reports)
-   * [Contribution](https://github.com/sepandhaghighi/pyrgg/blob/master/.github/CONTRIBUTING.md)
-   * [References](https://github.com/sepandhaghighi/pyrgg#references)
-   * [Citing](https://github.com/sepandhaghighi/pyrgg#citing)
-   * [Authors](https://github.com/sepandhaghighi/pyrgg/blob/master/AUTHORS.md)
-   * [License](https://github.com/sepandhaghighi/pyrgg/blob/master/LICENSE)
-   * [Show Your Support](https://github.com/sepandhaghighi/pyrgg#show-your-support)
-   * [Todo](https://github.com/sepandhaghighi/pyrgg/blob/master/TODO.md)
-   * [Changelog](https://github.com/sepandhaghighi/pyrgg/blob/master/CHANGELOG.md)
-   * [Code of Conduct](https://github.com/sepandhaghighi/pyrgg/blob/master/.github/CODE_OF_CONDUCT.md)			
+	<a href="https://www.pyrgg.site"><img src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=website"></a>
+	<a href="https://badge.fury.io/py/pyrgg"><img src="https://badge.fury.io/py/pyrgg.svg" alt="PyPI version" height="18"></a>
+	<a href="https://anaconda.org/sepandhaghighi/pyrgg"><img src="https://anaconda.org/sepandhaghighi/pyrgg/badges/version.svg"></a>
+	<a href="https://codecov.io/gh/sepandhaghighi/pyrgg"><img src="https://codecov.io/gh/sepandhaghighi/pyrgg/branch/master/graph/badge.svg" alt="Codecov"></a>
+	<a href="https://www.python.org/"><img src="https://img.shields.io/badge/built%20with-Python3-green.svg" alt="built with Python3"></a>
+	<a href="https://discord.gg/dfYAWVMaCW"><img src="https://img.shields.io/discord/1013411447130308669.svg" alt="Discord Channel"></a>
+</div>			
 				
 ## Overview	
 
@@ -463,7 +433,7 @@ Note that it may run on lower end equipment though good performance is not guara
 ## Issues & Bug Reports			
 
 Just fill an issue and describe it. We'll check it ASAP!							
-or send an email to [info@pyrgg.ir](mailto:info@pyrgg.ir "info@pyrgg.ir"). 
+or send an email to [info@pyrgg.site](mailto:info@pyrgg.site "info@pyrgg.site"). 
 
 You can also join our discord server			
 
@@ -544,30 +514,7 @@ Give a ⭐️ if this project helped you!
 
 <h3>Donate to Our Project</h3>	
 
-<h4>Bitcoin</h4>
-1KtNLEEeUbTEK9PdN6Ya3ZAKXaqoKUuxCy
-<h4>Ethereum</h4>
-0xcD4Db18B6664A9662123D4307B074aE968535388
-<h4>Litecoin</h4>
-Ldnz5gMcEeV8BAdsyf8FstWDC6uyYR6pgZ
-<h4>Doge</h4>
-DDUnKpFQbBqLpFVZ9DfuVysBdr249HxVDh
-<h4>Tron</h4>
-TCZxzPZLcJHr2qR3uPUB1tXB6L3FDSSAx7
-<h4>Ripple</h4>
-rN7ZuRG7HDGHR5nof8nu5LrsbmSB61V1qq
-<h4>Binance Coin</h4>
-bnb1zglwcf0ac3d0s2f6ck5kgwvcru4tlctt4p5qef
-<h4>Tether</h4>
-0xcD4Db18B6664A9662123D4307B074aE968535388
-<h4>Dash</h4>
-Xd3Yn2qZJ7VE8nbKw2fS98aLxR5M6WUU3s
-<h4>Stellar</h4>		
-GALPOLPISRHIYHLQER2TLJRGUSZH52RYDK6C3HIU4PSMNAV65Q36EGNL
-<h4>Zilliqa</h4>
-zil1knmz8zj88cf0exr2ry7nav9elehxfcgqu3c5e5
-<h4>Coffeete</h4>
-<a href="http://www.coffeete.ir/opensource">
-<img src="http://www.coffeete.ir/images/buttons/lemonchiffon.png" style="width:260px;" />
-</a>
+If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .			
+
+<a href="http://www.pyrgg.site/donate.html" target="_blank"><img src="https://github.com/sepandhaghighi/pyrgg/raw/master/otherfile/donate-button.png" height="90px" width="270px" alt="PyRGG Donation"></a>
 
diff --git a/TODO.md b/TODO.md
diff --git a/otherfile/donate-button.png b/otherfile/donate-button.png
diff --git a/otherfile/meta.yaml b/otherfile/meta.yaml
@@ -28,7 +28,7 @@ about:
     description: |
         PyRGG is a user-friendly synthetic random graph generator that is written in Python and supports multiple graph file formats, such as DIMACS-Graph files. It can generate graphs of various sizes and is specifically designed to create input files for a wide range of graph-based research applications, including testing, benchmarking, and performance analysis of graph processing frameworks. PyRGG is aimed at computer scientists who are studying graph algorithms and graph processing frameworks.
 
-        Website: https://www.pyrgg.ir
+        Website: https://www.pyrgg.site
 
         Repo: https://github.com/sepandhaghighi/pyrgg
 extra:

diff --git a/pyrgg/params.py b/pyrgg/params.py
@@ -101,7 +101,7 @@
 CONFIG_FILE_FORMAT = "{}.pyrgg.config.json"
 
 PYRGG_LINKS = """
-Webpage : https://www.pyrgg.ir
+Webpage : https://www.pyrgg.site
 Repository : https://github.com/sepandhaghighi/pyrgg
 Paper : https://doi.org/10.21105/joss.00331
 * If you use Pyrgg in your research, please cite our paper

diff --git a/setup.py b/setup.py
@@ -44,12 +44,12 @@ def read_description():
     long_description=read_description(),
     long_description_content_type='text/markdown',
     author='PyRGG Development Team',
-    author_email='info@pyrgg.ir',
+    author_email='info@pyrgg.site',
     url='https://github.com/sepandhaghighi/pyrgg',
     download_url='https://github.com/sepandhaghighi/pyrgg/tarball/v1.4',
     keywords='random graph python3 python generator graph-process generator DIMACS JSON YAML Pickle CSV TSV WEL ASP TGF UCINET',
     project_urls={
-        'Webpage': 'https://www.pyrgg.ir',
+        'Webpage': 'https://www.pyrgg.site',
         'Source': 'https://github.com/sepandhaghighi/pyrgg',
     },
     install_requires=get_requires(),

diff --git a/test/functions_test.py b/test/functions_test.py
@@ -7,7 +7,7 @@
 >>> os.environ["PYRGG_TEST_MODE"] = "1"
 >>> description_print()
 <BLANKLINE>
-Webpage : https://www.pyrgg.ir
+Webpage : https://www.pyrgg.site
 Repository : https://github.com/sepandhaghighi/pyrgg
 Paper : https://doi.org/10.21105/joss.00331
 * If you use Pyrgg in your research, please cite our paper
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		custom: https://www.pyrgg.ir/donate.html
		custom: https://www.pyrgg.site/donate.html