apscale-installer 0.2__tar.gz → 0.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,93 @@
1
+ Metadata-Version: 2.1
2
+ Name: apscale_installer
3
+ Version: 0.4
4
+ Summary: Advanced Pipeline for Simple yet Comprehensive AnaLysEs of DNA metabarcoding data - Conda installer (workaround)
5
+ Home-page: https://pypi.org/project/apscale_installer/
6
+ Author: Till-Hendrik Macher
7
+ Author-email: macher@uni-trier.de
8
+ License: MIT
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: License :: OSI Approved :: MIT License
11
+ Classifier: Operating System :: OS Independent
12
+ Requires-Python: >=3.10
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENSE
15
+ Requires-Dist: Requests==2.32.3
16
+
17
+ # Apscale Installer
18
+
19
+ ## Installation Tutorial for the Apscale Metabarcoding Workflow
20
+
21
+ ## Introduction
22
+
23
+ The easiest way to install the apscale metabarcoding workflow is by using [Miniconda3](https://docs.anaconda.com/miniconda/#). Miniconda will create an isolated environment with all the suggested versions of each tool.
24
+
25
+ > **Note:** Currently, [vsearch](https://github.com/torognes/vsearch) and [blast+](https://blast.ncbi.nlm.nih.gov/doc/blast-help/downloadblastdata.html) cannot be automatically installed via conda. For now, the easiest solution is the installation through the apscale-installer script. We will update this Wiki when vsearch and blast+ are available via conda. Linux users can install vsearch and blast+ already now using conda.
26
+
27
+ This tutorial will install the following tools:
28
+ * [Apscale](https://github.com/DominikBuchner/apscale)
29
+ * [Apscale-GUI](https://github.com/TillMacher/apscale_gui)
30
+ * [Apscale_blast](https://github.com/TillMacher/apscale_blast)
31
+ * [Boldigger2](https://github.com/DominikBuchner/BOLDigger2)
32
+ * [Demultiplexer](https://github.com/DominikBuchner/demultiplexer)
33
+ * TaxonTableTool2 (coming soon)
34
+
35
+ ## Miniconda Installation
36
+
37
+ 1. Install Miniconda by following the instructions.
38
+
39
+ 2. Open a new Anaconda (Miniconda3) terminal.
40
+ - **Windows**: Type 'Anaconda' in your search bar and select 'Anaconda Powershell Prompt (miniconda3)'.
41
+ - **MacOS**: Open a new terminal. You will see the (base) environment before your user name.
42
+
43
+ 3. Download the respective environment installation file for [Windows](https://github.com/TillMacher/apscale_installer/blob/main/environments/metabarcoding_env_windows_x64.yml) or [MacOS](https://github.com/TillMacher/apscale_installer/blob/main/environments/metabarcoding_env_macos_aarch64.yml).
44
+
45
+ 4. Install the metabarcoding environment by typing:
46
+ ```sh
47
+ conda env create -f metabarcoding_env_XXX.yml
48
+
49
+ 5. Ensure you provide the correct path, for example:
50
+ ```sh
51
+ conda env create -f /Users/tillmacher/Downloads/metabarcoding_env_macos_aarch64.yml
52
+
53
+ 6. This should automatically install all dependencies. After the installation, activate the environment:
54
+ ```sh
55
+ conda activate metabarcoding
56
+
57
+ 7. **Windows and MacOS** users run the apscale-installer script:
58
+ ```sh
59
+ apscale_installer
60
+
61
+ 8. **Linux and MacOS (intel)** users can use conda:
62
+ ```sh
63
+ conda install vsearch
64
+ conda install blast
65
+
66
+ 9. Verify your installations:
67
+ ```sh
68
+ vsearch --help
69
+ blastn -h
70
+
71
+ * If you want to update the metabarcoding environment type:
72
+ ```sh
73
+ conda env update --file metabarcoding_env_XXX.yml --prune
74
+
75
+ * If you want to uninstall the metabarcoding environment type:
76
+ ```sh
77
+ conda remove -n metabarcoding --all
78
+
79
+ ## Usage
80
+
81
+ Now that everything is installed, you can use the installed software.
82
+
83
+ Refer to the homepages of each program to run learn how to use them:
84
+ * [Apscale](https://github.com/DominikBuchner/apscale/tree/main?tab=readme-ov-file#how-to-use)
85
+ * [Apscale-GUI](https://github.com/TillMacher/apscale_gui)
86
+ * [Apscale_blast](https://github.com/TillMacher/apscale_blast?tab=readme-ov-file#how-to-use)
87
+ * [Boldigger2](https://github.com/DominikBuchner/BOLDigger2?tab=readme-ov-file#installation-and-usage)
88
+ * [Demultiplexer](https://github.com/DominikBuchner/demultiplexer?tab=readme-ov-file#how-to-use)
89
+ * TaxonTableTool2 (coming soon)
90
+
91
+ ## Video tutorial
92
+ There is also a [YouTube tutorial](https://www.youtube.com/watch?v=c6pm0FhcINI) available, where the installation of **Windows** and **MacOS** is demonstrated.
93
+
@@ -0,0 +1,77 @@
1
+ # Apscale Installer
2
+
3
+ ## Installation Tutorial for the Apscale Metabarcoding Workflow
4
+
5
+ ## Introduction
6
+
7
+ The easiest way to install the apscale metabarcoding workflow is by using [Miniconda3](https://docs.anaconda.com/miniconda/#). Miniconda will create an isolated environment with all the suggested versions of each tool.
8
+
9
+ > **Note:** Currently, [vsearch](https://github.com/torognes/vsearch) and [blast+](https://blast.ncbi.nlm.nih.gov/doc/blast-help/downloadblastdata.html) cannot be automatically installed via conda. For now, the easiest solution is the installation through the apscale-installer script. We will update this Wiki when vsearch and blast+ are available via conda. Linux users can install vsearch and blast+ already now using conda.
10
+
11
+ This tutorial will install the following tools:
12
+ * [Apscale](https://github.com/DominikBuchner/apscale)
13
+ * [Apscale-GUI](https://github.com/TillMacher/apscale_gui)
14
+ * [Apscale_blast](https://github.com/TillMacher/apscale_blast)
15
+ * [Boldigger2](https://github.com/DominikBuchner/BOLDigger2)
16
+ * [Demultiplexer](https://github.com/DominikBuchner/demultiplexer)
17
+ * TaxonTableTool2 (coming soon)
18
+
19
+ ## Miniconda Installation
20
+
21
+ 1. Install Miniconda by following the instructions.
22
+
23
+ 2. Open a new Anaconda (Miniconda3) terminal.
24
+ - **Windows**: Type 'Anaconda' in your search bar and select 'Anaconda Powershell Prompt (miniconda3)'.
25
+ - **MacOS**: Open a new terminal. You will see the (base) environment before your user name.
26
+
27
+ 3. Download the respective environment installation file for [Windows](https://github.com/TillMacher/apscale_installer/blob/main/environments/metabarcoding_env_windows_x64.yml) or [MacOS](https://github.com/TillMacher/apscale_installer/blob/main/environments/metabarcoding_env_macos_aarch64.yml).
28
+
29
+ 4. Install the metabarcoding environment by typing:
30
+ ```sh
31
+ conda env create -f metabarcoding_env_XXX.yml
32
+
33
+ 5. Ensure you provide the correct path, for example:
34
+ ```sh
35
+ conda env create -f /Users/tillmacher/Downloads/metabarcoding_env_macos_aarch64.yml
36
+
37
+ 6. This should automatically install all dependencies. After the installation, activate the environment:
38
+ ```sh
39
+ conda activate metabarcoding
40
+
41
+ 7. **Windows and MacOS** users run the apscale-installer script:
42
+ ```sh
43
+ apscale_installer
44
+
45
+ 8. **Linux and MacOS (intel)** users can use conda:
46
+ ```sh
47
+ conda install vsearch
48
+ conda install blast
49
+
50
+ 9. Verify your installations:
51
+ ```sh
52
+ vsearch --help
53
+ blastn -h
54
+
55
+ * If you want to update the metabarcoding environment type:
56
+ ```sh
57
+ conda env update --file metabarcoding_env_XXX.yml --prune
58
+
59
+ * If you want to uninstall the metabarcoding environment type:
60
+ ```sh
61
+ conda remove -n metabarcoding --all
62
+
63
+ ## Usage
64
+
65
+ Now that everything is installed, you can use the installed software.
66
+
67
+ Refer to the homepages of each program to run learn how to use them:
68
+ * [Apscale](https://github.com/DominikBuchner/apscale/tree/main?tab=readme-ov-file#how-to-use)
69
+ * [Apscale-GUI](https://github.com/TillMacher/apscale_gui)
70
+ * [Apscale_blast](https://github.com/TillMacher/apscale_blast?tab=readme-ov-file#how-to-use)
71
+ * [Boldigger2](https://github.com/DominikBuchner/BOLDigger2?tab=readme-ov-file#installation-and-usage)
72
+ * [Demultiplexer](https://github.com/DominikBuchner/demultiplexer?tab=readme-ov-file#how-to-use)
73
+ * TaxonTableTool2 (coming soon)
74
+
75
+ ## Video tutorial
76
+ There is also a [YouTube tutorial](https://www.youtube.com/watch?v=c6pm0FhcINI) available, where the installation of **Windows** and **MacOS** is demonstrated.
77
+
@@ -24,17 +24,29 @@ def download_blast(url, file_name):
24
24
 
25
25
  extract_path = os.path.dirname(file_name)
26
26
 
27
- # Open the tar.gz file
28
- with tarfile.open(file_name, "r:gz") as tar:
29
- # Extract all the contents to the same directory
30
- tar.extractall(path=extract_path)
27
+ # Extract the file based on its extension
28
+ if file_name.endswith('.tar.gz') or file_name.endswith('.tgz'):
29
+ shutil.unpack_archive(file_name, extract_path, 'gztar')
30
+ folder = file_name.replace('.tar.gz', '').replace('.tgz', '')
31
+ elif file_name.endswith('.tar.bz2') or file_name.endswith('.tbz'):
32
+ shutil.unpack_archive(file_name, extract_path, 'bztar')
33
+ folder = file_name.replace('.tar.bz2', '').replace('.bztar', '')
34
+ elif file_name.endswith('.tar.xz') or file_name.endswith('.txz'):
35
+ shutil.unpack_archive(file_name, extract_path, 'xztar')
36
+ folder = file_name.replace('.tar.xz', '').replace('.xztar', '')
37
+ elif file_name.endswith('.zip'):
38
+ shutil.unpack_archive(file_name, extract_path, 'zip')
39
+ folder = file_name.replace('.zip', '')
40
+
31
41
  print("Unpacking complete!")
32
42
 
33
43
  ########################################################################################################################
34
44
  ## Find install directory
35
45
 
46
+ print(os.environ['PATH'])
47
+
36
48
  # Run the conda info command
37
- result = subprocess.run(['conda', 'info', '--json'], stdout=subprocess.PIPE)
49
+ result = subprocess.run('conda info --json', shell=True, stdout=subprocess.PIPE)
38
50
  # Parse the JSON output
39
51
  conda_info = json.loads(result.stdout)
40
52
  # Get the current environment path
@@ -55,13 +67,13 @@ def download_blast(url, file_name):
55
67
  for file in bin_files:
56
68
  moved_file = env_path.joinpath(Path(file).name)
57
69
  shutil.copy(file, moved_file)
58
- print("Finished installation!")
70
+ print("Copied files!")
59
71
 
60
72
  ########################################################################################################################
61
73
  ## Update PATH
62
74
 
63
75
  os.environ["PATH"] += os.pathsep + str(env_path)
64
- print(f"Updated PATH: {os.environ['PATH']}")
76
+ print("Finished installation!")
65
77
 
66
78
  def download_vsearch(url, file_name):
67
79
  ########################################################################################################################
@@ -79,17 +91,27 @@ def download_vsearch(url, file_name):
79
91
 
80
92
  extract_path = os.path.dirname(file_name)
81
93
 
82
- # Open the tar.gz file
83
- with tarfile.open(file_name, "r:gz") as tar:
84
- # Extract all the contents to the same directory
85
- tar.extractall(path=extract_path)
94
+ # Extract the file based on its extension
95
+ if file_name.endswith('.tar.gz') or file_name.endswith('.tgz'):
96
+ shutil.unpack_archive(file_name, extract_path, 'gztar')
97
+ folder = file_name.replace('.tar.gz', '').replace('.tgz', '')
98
+ elif file_name.endswith('.tar.bz2') or file_name.endswith('.tbz'):
99
+ shutil.unpack_archive(file_name, extract_path, 'bztar')
100
+ folder = file_name.replace('.tar.bz2', '').replace('.bztar', '')
101
+ elif file_name.endswith('.tar.xz') or file_name.endswith('.txz'):
102
+ shutil.unpack_archive(file_name, extract_path, 'xztar')
103
+ folder = file_name.replace('.tar.xz', '').replace('.xztar', '')
104
+ elif file_name.endswith('.zip'):
105
+ shutil.unpack_archive(file_name, extract_path, 'zip')
106
+ folder = file_name.replace('.zip', '')
107
+
86
108
  print("Unpacking complete!")
87
109
 
88
110
  ########################################################################################################################
89
111
  ## Find install directory
90
112
 
91
113
  # Run the conda info command
92
- result = subprocess.run(['conda', 'info', '--json'], stdout=subprocess.PIPE)
114
+ result = subprocess.run('conda info --json', shell=True, stdout=subprocess.PIPE)
93
115
  # Parse the JSON output
94
116
  conda_info = json.loads(result.stdout)
95
117
  # Get the current environment path
@@ -103,20 +125,24 @@ def download_vsearch(url, file_name):
103
125
  ## Move files to bin
104
126
 
105
127
  # Collect files
106
- folder = file_name.replace('.tar.gz', '')
107
128
  bin_files = glob.glob(str(Path(f'./{extract_path}/{folder}/bin/*')))
108
129
 
109
130
  # Move files
110
131
  for file in bin_files:
111
132
  moved_file = env_path.joinpath(Path(file).name)
112
133
  shutil.copy(file, moved_file)
113
- print("Finished installation!")
134
+ print("Copied files!")
114
135
 
115
136
  ########################################################################################################################
116
137
  ## Update PATH
117
138
 
118
139
  os.environ["PATH"] += os.pathsep + str(env_path)
119
- print(f"Updated PATH: {os.environ['PATH']}")
140
+ print("Finished installation!")
141
+
142
+ def download_playwright():
143
+ print("Starting to install playwright!")
144
+ result = subprocess.run('playwright install', shell=True, stdout=subprocess.PIPE)
145
+ print("Finished installation!")
120
146
 
121
147
  def main():
122
148
  ## OS-specific download
@@ -148,5 +174,8 @@ def main():
148
174
  file_name = url.split('/')[-1]
149
175
  download_vsearch(url, file_name)
150
176
 
177
+ ## boldigger3 playwright
178
+ download_playwright()
179
+
151
180
  if __name__ == "__main__":
152
181
  main()
@@ -0,0 +1,93 @@
1
+ Metadata-Version: 2.1
2
+ Name: apscale_installer
3
+ Version: 0.4
4
+ Summary: Advanced Pipeline for Simple yet Comprehensive AnaLysEs of DNA metabarcoding data - Conda installer (workaround)
5
+ Home-page: https://pypi.org/project/apscale_installer/
6
+ Author: Till-Hendrik Macher
7
+ Author-email: macher@uni-trier.de
8
+ License: MIT
9
+ Classifier: Programming Language :: Python :: 3
10
+ Classifier: License :: OSI Approved :: MIT License
11
+ Classifier: Operating System :: OS Independent
12
+ Requires-Python: >=3.10
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENSE
15
+ Requires-Dist: Requests==2.32.3
16
+
17
+ # Apscale Installer
18
+
19
+ ## Installation Tutorial for the Apscale Metabarcoding Workflow
20
+
21
+ ## Introduction
22
+
23
+ The easiest way to install the apscale metabarcoding workflow is by using [Miniconda3](https://docs.anaconda.com/miniconda/#). Miniconda will create an isolated environment with all the suggested versions of each tool.
24
+
25
+ > **Note:** Currently, [vsearch](https://github.com/torognes/vsearch) and [blast+](https://blast.ncbi.nlm.nih.gov/doc/blast-help/downloadblastdata.html) cannot be automatically installed via conda. For now, the easiest solution is the installation through the apscale-installer script. We will update this Wiki when vsearch and blast+ are available via conda. Linux users can install vsearch and blast+ already now using conda.
26
+
27
+ This tutorial will install the following tools:
28
+ * [Apscale](https://github.com/DominikBuchner/apscale)
29
+ * [Apscale-GUI](https://github.com/TillMacher/apscale_gui)
30
+ * [Apscale_blast](https://github.com/TillMacher/apscale_blast)
31
+ * [Boldigger2](https://github.com/DominikBuchner/BOLDigger2)
32
+ * [Demultiplexer](https://github.com/DominikBuchner/demultiplexer)
33
+ * TaxonTableTool2 (coming soon)
34
+
35
+ ## Miniconda Installation
36
+
37
+ 1. Install Miniconda by following the instructions.
38
+
39
+ 2. Open a new Anaconda (Miniconda3) terminal.
40
+ - **Windows**: Type 'Anaconda' in your search bar and select 'Anaconda Powershell Prompt (miniconda3)'.
41
+ - **MacOS**: Open a new terminal. You will see the (base) environment before your user name.
42
+
43
+ 3. Download the respective environment installation file for [Windows](https://github.com/TillMacher/apscale_installer/blob/main/environments/metabarcoding_env_windows_x64.yml) or [MacOS](https://github.com/TillMacher/apscale_installer/blob/main/environments/metabarcoding_env_macos_aarch64.yml).
44
+
45
+ 4. Install the metabarcoding environment by typing:
46
+ ```sh
47
+ conda env create -f metabarcoding_env_XXX.yml
48
+
49
+ 5. Ensure you provide the correct path, for example:
50
+ ```sh
51
+ conda env create -f /Users/tillmacher/Downloads/metabarcoding_env_macos_aarch64.yml
52
+
53
+ 6. This should automatically install all dependencies. After the installation, activate the environment:
54
+ ```sh
55
+ conda activate metabarcoding
56
+
57
+ 7. **Windows and MacOS** users run the apscale-installer script:
58
+ ```sh
59
+ apscale_installer
60
+
61
+ 8. **Linux and MacOS (intel)** users can use conda:
62
+ ```sh
63
+ conda install vsearch
64
+ conda install blast
65
+
66
+ 9. Verify your installations:
67
+ ```sh
68
+ vsearch --help
69
+ blastn -h
70
+
71
+ * If you want to update the metabarcoding environment type:
72
+ ```sh
73
+ conda env update --file metabarcoding_env_XXX.yml --prune
74
+
75
+ * If you want to uninstall the metabarcoding environment type:
76
+ ```sh
77
+ conda remove -n metabarcoding --all
78
+
79
+ ## Usage
80
+
81
+ Now that everything is installed, you can use the installed software.
82
+
83
+ Refer to the homepages of each program to run learn how to use them:
84
+ * [Apscale](https://github.com/DominikBuchner/apscale/tree/main?tab=readme-ov-file#how-to-use)
85
+ * [Apscale-GUI](https://github.com/TillMacher/apscale_gui)
86
+ * [Apscale_blast](https://github.com/TillMacher/apscale_blast?tab=readme-ov-file#how-to-use)
87
+ * [Boldigger2](https://github.com/DominikBuchner/BOLDigger2?tab=readme-ov-file#installation-and-usage)
88
+ * [Demultiplexer](https://github.com/DominikBuchner/demultiplexer?tab=readme-ov-file#how-to-use)
89
+ * TaxonTableTool2 (coming soon)
90
+
91
+ ## Video tutorial
92
+ There is also a [YouTube tutorial](https://www.youtube.com/watch?v=c6pm0FhcINI) available, where the installation of **Windows** and **MacOS** is demonstrated.
93
+
@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
5
5
 
6
6
  setuptools.setup(
7
7
  name="apscale_installer",
8
- version="0.2",
8
+ version="0.4",
9
9
  author="Till-Hendrik Macher",
10
10
  author_email="macher@uni-trier.de",
11
11
  description="Advanced Pipeline for Simple yet Comprehensive AnaLysEs of DNA metabarcoding data - Conda installer (workaround)",
@@ -1,25 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: apscale_installer
3
- Version: 0.2
4
- Summary: Advanced Pipeline for Simple yet Comprehensive AnaLysEs of DNA metabarcoding data - Conda installer (workaround)
5
- Home-page: https://pypi.org/project/apscale_installer/
6
- Author: Till-Hendrik Macher
7
- Author-email: macher@uni-trier.de
8
- License: MIT
9
- Classifier: Programming Language :: Python :: 3
10
- Classifier: License :: OSI Approved :: MIT License
11
- Classifier: Operating System :: OS Independent
12
- Requires-Python: >=3.10
13
- Description-Content-Type: text/markdown
14
- License-File: LICENSE
15
- Requires-Dist: Requests==2.32.3
16
-
17
- # apscale
18
- Advanced Pipeline for Simple yet Comprehensive AnaLysEs of DNA metabarcoding data
19
-
20
- [![Downloads](https://static.pepy.tech/badge/apscale)](https://pepy.tech/project/apscale) - apscale
21
-
22
- [![Downloads](https://static.pepy.tech/badge/apscale-blast)](https://pepy.tech/project/apscale-blast) - apscale_blast
23
-
24
- # apscale installer
25
- A script to automatically download and install vsearch and blastn on Windows and MacOS (aarch64) until both dependencies are released for conda.
@@ -1,9 +0,0 @@
1
- # apscale
2
- Advanced Pipeline for Simple yet Comprehensive AnaLysEs of DNA metabarcoding data
3
-
4
- [![Downloads](https://static.pepy.tech/badge/apscale)](https://pepy.tech/project/apscale) - apscale
5
-
6
- [![Downloads](https://static.pepy.tech/badge/apscale-blast)](https://pepy.tech/project/apscale-blast) - apscale_blast
7
-
8
- # apscale installer
9
- A script to automatically download and install vsearch and blastn on Windows and MacOS (aarch64) until both dependencies are released for conda.
@@ -1,25 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: apscale_installer
3
- Version: 0.2
4
- Summary: Advanced Pipeline for Simple yet Comprehensive AnaLysEs of DNA metabarcoding data - Conda installer (workaround)
5
- Home-page: https://pypi.org/project/apscale_installer/
6
- Author: Till-Hendrik Macher
7
- Author-email: macher@uni-trier.de
8
- License: MIT
9
- Classifier: Programming Language :: Python :: 3
10
- Classifier: License :: OSI Approved :: MIT License
11
- Classifier: Operating System :: OS Independent
12
- Requires-Python: >=3.10
13
- Description-Content-Type: text/markdown
14
- License-File: LICENSE
15
- Requires-Dist: Requests==2.32.3
16
-
17
- # apscale
18
- Advanced Pipeline for Simple yet Comprehensive AnaLysEs of DNA metabarcoding data
19
-
20
- [![Downloads](https://static.pepy.tech/badge/apscale)](https://pepy.tech/project/apscale) - apscale
21
-
22
- [![Downloads](https://static.pepy.tech/badge/apscale-blast)](https://pepy.tech/project/apscale-blast) - apscale_blast
23
-
24
- # apscale installer
25
- A script to automatically download and install vsearch and blastn on Windows and MacOS (aarch64) until both dependencies are released for conda.
File without changes