Skip to content

Commit

Permalink
Create pip release
Browse files Browse the repository at this point in the history
  • Loading branch information
lipelopesoliveira committed Mar 3, 2024
1 parent 9138cbd commit 9a6c8ea
Show file tree
Hide file tree
Showing 20 changed files with 8,574 additions and 7 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,13 @@ conda env create --file environment.yml

## Installation

Currently the best way to use pyCOFBuilder is to manually import it using the `sys` module, as exemplified below:
You can install pyCOFBuilder using pip:

```Shell
pip install pycofbuilder
```

Alternativelly, you can use pyCOFBuilder by manually import it using the `sys` module, as exemplified below:

```python
# importing module
Expand Down
48 changes: 48 additions & 0 deletions build/lib/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# -*- coding: utf-8 -*-
# Created by Felipe Lopes de Oliveira
# Distributed under the terms of the MIT License.

import os
import sys

# This code is written for Python 3
if sys.version_info[0] != 3:
raise Exception("Sorry but pyCOFBuilder requires Python 3.")
sys.exit(1)

# Import BuildingBlocks class
from pycofbuilder.building_block import BuildingBlock

# Import Framework class
from pycofbuilder.framework import Framework

# Import Tools
import pycofbuilder.tools as Tools
import pycofbuilder.io_tools as IO_Tools

# Import ChemJSON
import pycofbuilder.chemjson as ChemJSON

# Import Exceptions
import pycofbuilder.exceptions as Exceptions

# Import Logger
import pycofbuilder.logger as Logger

__all__ = [
'BuildingBlock',
'Framework',
'Tools',
'IO_Tools',
'ChemJSON',
'Exceptions',
'Logger'
]

_ROOT = os.path.abspath(os.path.dirname(__file__))

__author__ = "Felipe Lopes de Oliveira"
__license__ = "MIT"
__version__ = '0.0.6'
__email__ = "felipe.lopes@nano.ufrj.br"
__status__ = "Development"
Loading

0 comments on commit 9a6c8ea

Please sign in to comment.