Syncfreedom-lib
=================
This is the public repository for users of
SyncFreedom.com to simplify their development.
The point of this project is to help you
develop accounting utilities using the same
python-quickbooks library that's used in typical
web development. That library is well documented
but is inaccessible to the layman without first
creating a UI to collect auth codes. SyncFreedom
handles the authorization aspect of the development
allowing you to focus on your utility.
My goal in creating this service is to make python
more accessible to accountants. I encourage accountants
to use and adopt python as THE general purpose programing
language for accountants.
The main difference between your development with
the python-quickbooks package and this package is
the QuickBooks class. Anytime you would normally
use the QuickBooks class from the python-quickbooks
package you would replace it with SyncFreedomQuickBooks
class. The SyncFreedomQuickBooks is also different
because it takes the company_id (realm_id) and your
SyncFreedom credentials as arguments.
For example:
from syncfreedom.client import SyncFreedomQuickBooks
from quickbooks.objects.account import Account
credentials = {
'username':'your_syncfreedom_username',
'password':'your_syncfreedom_password'
}
qb = SyncFreedomQuickBooks(
company_id=self.company_id,
credentials=credentials
)
customers = Customer.all(qb=qb)
It is best practice to place your credentials in a
config.ini file. Here is an example of the text
in config.ini file:
[SYNCFREEDOM_CREDENTIALS]
username = your_syncfreedom_username
password = your_syncfreedom_password
[ENVIRONMENT_INFO]
environment=Production
sync_freedom_url=https://syncfreedom.com
When your credentials are inside of the config.ini file
you will access the credentials and use this package like
the following:
from syncfreedom.client import SyncFreedomQuickBooks
from quickbooks.objects.account import Account
from configparser import ConfigParser
configur = ConfigParser()
configur.read(r"""C:\your_file_path_to_the_config_file\config.ini"""))
credentials = configur['SYNCFREEDOM_CREDENTIALS']
qb = SyncFreedomQuickBooks(
company_id=self.company_id,
credentials=credentials
)
customers = Customer.all(qb=qb)
If you are trying to get the full list of connections in SyncFreedom
use the SyncFreedomConnections class like the following:
from syncfreedom.client import SyncFreedomQuickBooks, SyncFreedomQBOConnections
from configparser import ConfigParser
configur = ConfigParser()
configur.read(r"""C:\your_file_path_to_the_config_file\config.ini"""))
credentials = configur['SYNCFREEDOM_CREDENTIALS']
qbo_connections = SyncFreedomQBOConnections(self.credentials)
#then create qb from the connections list
connection = qbo_connections.get_by_company_name('My Company Name')
qb = SyncFreedomQuickBooks(
company_id=connection.company_id,
credentials=credentials
)
customers = Customer.all(qb=qb)
Raw data
{
"_id": null,
"home_page": "https://github.com/selfjared1/syncfreedom-lib/releases/tag/0.1",
"name": "syncfreedom",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "quickbooks online,quickbooks",
"author": "Jared Self",
"author_email": "jared@quickbooksgg.com",
"download_url": "https://files.pythonhosted.org/packages/be/87/6f8002164c6dafcc54aa95d7b4a85ac51aa7a03a814dc16e82a60b1a6642/syncfreedom-1.0.7.tar.gz",
"platform": null,
"description": "Syncfreedom-lib\r\n=================\r\n\r\nThis is the public repository for users of \r\nSyncFreedom.com to simplify their development. \r\nThe point of this project is to help you \r\ndevelop accounting utilities using the same \r\npython-quickbooks library that's used in typical \r\nweb development. That library is well documented \r\nbut is inaccessible to the layman without first \r\ncreating a UI to collect auth codes. SyncFreedom \r\nhandles the authorization aspect of the development\r\nallowing you to focus on your utility. \r\n\r\nMy goal in creating this service is to make python \r\nmore accessible to accountants. I encourage accountants \r\nto use and adopt python as THE general purpose programing \r\nlanguage for accountants. \r\n\r\nThe main difference between your development with \r\nthe python-quickbooks package and this package is \r\nthe QuickBooks class. Anytime you would normally \r\nuse the QuickBooks class from the python-quickbooks \r\npackage you would replace it with SyncFreedomQuickBooks \r\nclass. The SyncFreedomQuickBooks is also different \r\nbecause it takes the company_id (realm_id) and your \r\nSyncFreedom credentials as arguments.\r\n\r\nFor example:\r\n\r\n from syncfreedom.client import SyncFreedomQuickBooks\r\n from quickbooks.objects.account import Account\r\n \r\n credentials = {\r\n 'username':'your_syncfreedom_username', \r\n 'password':'your_syncfreedom_password'\r\n }\r\n qb = SyncFreedomQuickBooks(\r\n company_id=self.company_id, \r\n credentials=credentials\r\n )\r\n customers = Customer.all(qb=qb)\r\n\r\nIt is best practice to place your credentials in a \r\nconfig.ini file. Here is an example of the text \r\nin config.ini file:\r\n\r\n [SYNCFREEDOM_CREDENTIALS]\r\n username = your_syncfreedom_username\r\n password = your_syncfreedom_password\r\n \r\n [ENVIRONMENT_INFO]\r\n environment=Production\r\n sync_freedom_url=https://syncfreedom.com\r\n\r\n\r\nWhen your credentials are inside of the config.ini file \r\nyou will access the credentials and use this package like \r\nthe following:\r\n\r\n from syncfreedom.client import SyncFreedomQuickBooks\r\n from quickbooks.objects.account import Account\r\n from configparser import ConfigParser\r\n \r\n configur = ConfigParser()\r\n configur.read(r\"\"\"C:\\your_file_path_to_the_config_file\\config.ini\"\"\"))\r\n \r\n credentials = configur['SYNCFREEDOM_CREDENTIALS']\r\n \r\n qb = SyncFreedomQuickBooks(\r\n company_id=self.company_id, \r\n credentials=credentials\r\n )\r\n customers = Customer.all(qb=qb)\r\n\r\nIf you are trying to get the full list of connections in SyncFreedom\r\nuse the SyncFreedomConnections class like the following:\r\n\r\n from syncfreedom.client import SyncFreedomQuickBooks, SyncFreedomQBOConnections\r\n from configparser import ConfigParser\r\n \r\n configur = ConfigParser()\r\n configur.read(r\"\"\"C:\\your_file_path_to_the_config_file\\config.ini\"\"\"))\r\n\r\n credentials = configur['SYNCFREEDOM_CREDENTIALS']\r\n qbo_connections = SyncFreedomQBOConnections(self.credentials)\r\n\r\n #then create qb from the connections list\r\n connection = qbo_connections.get_by_company_name('My Company Name')\r\n qb = SyncFreedomQuickBooks(\r\n company_id=connection.company_id, \r\n credentials=credentials\r\n )\r\n customers = Customer.all(qb=qb)\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Initial Release",
"version": "1.0.7",
"project_urls": {
"Bug Tracker": "https://github.com/selfjared1/syncfreedom-lib/issues",
"Download": "https://github.com/selfjared1/syncfreedom-lib/archive/refs/tags/0.1.zip",
"Homepage": "https://github.com/selfjared1/syncfreedom-lib/releases/tag/0.1"
},
"split_keywords": [
"quickbooks online",
"quickbooks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f7727a1578b5bd40c6f297365bced723d13387f41a1f1314445049ff610e1b9",
"md5": "6937d992bf6ce73eb529b0527d87556f",
"sha256": "b8e238cd03aeb1e4baac92a5b19459babea983b3e5487a5e09ac46a7917f9603"
},
"downloads": -1,
"filename": "syncfreedom-1.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6937d992bf6ce73eb529b0527d87556f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 6480,
"upload_time": "2024-01-23T03:38:23",
"upload_time_iso_8601": "2024-01-23T03:38:23.036232Z",
"url": "https://files.pythonhosted.org/packages/9f/77/27a1578b5bd40c6f297365bced723d13387f41a1f1314445049ff610e1b9/syncfreedom-1.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "be876f8002164c6dafcc54aa95d7b4a85ac51aa7a03a814dc16e82a60b1a6642",
"md5": "83ab141ca2b2358687dc9a69d1fdc5a3",
"sha256": "f530135eaa6922e1a5a77f9c79fc8b8fae34700395819a437da7de2c239d6762"
},
"downloads": -1,
"filename": "syncfreedom-1.0.7.tar.gz",
"has_sig": false,
"md5_digest": "83ab141ca2b2358687dc9a69d1fdc5a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 7250,
"upload_time": "2024-01-23T03:38:24",
"upload_time_iso_8601": "2024-01-23T03:38:24.491765Z",
"url": "https://files.pythonhosted.org/packages/be/87/6f8002164c6dafcc54aa95d7b4a85ac51aa7a03a814dc16e82a60b1a6642/syncfreedom-1.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-23 03:38:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "selfjared1",
"github_project": "syncfreedom-lib",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "syncfreedom"
}
JSON
